get-path (

OperationClassification cjs)

Useful functions to get paths within King OS.

Depends on

sdk-operations, which makes it only work inside of a typerepo.

returns project root folder path

recursive. goes up until it finds a folder that's the project root

if no source path is given, uses the directory name where the function is executed from as a starting point

returns project root folder path

recursive. goes up until it finds a folder that's the project root

if no source path is given, uses the directory name where the function is executed from as a starting point

Makes a path relative using proper parsing

Resulting path will apply the paths conventions

• no slash at the end
• no slash at the beginning

Makes a path relative using proper parsing

Resulting path will apply the paths conventions

• no slash at the end
• no slash at the beginning

Gets a path of any operation in the project

TODO: IDEA: maybe auto-generate key-value JSON where keys are the package-names of all operations and values are paths of their locations in the file system. we can easily generate this ourselves, but maybe it's also easy to use the npm yarn workspace for this, although it may not be available in all circumstances, so better not rely on it. The advantage of this would be that this function becomes sync and is much more efficient. The disadvantage is that every time you move something or add something new, this indexation has to happen, otherwise it fails.

returns an array of all (absolute) paths containing operations

for a bundled project, that means /apps, /packages, /modules

for the OS project, that means /operations/tools and /operations/niches

returns an array of all (absolute) paths containing operations

for a bundled project, that means /apps, /packages, /modules

for the OS project, that means /operations/tools and /operations/niches

Gets project path, or a folder in the root that is convention

returns a file id (path without extension) relative to the src folder of an operation

e.g. "general" for src/general.ts

NB: assumes all src is in the src folder

NB: removes "/" in the beginning, if found

returns a file id (path without extension) relative to the src folder of an operation

e.g. "general" for src/general.ts

NB: assumes all src is in the src folder

NB: removes "/" in the beginning, if found

Returns

OperationClassification if it's an operation, or undefined if it's not

NB: don't confuse this with

ImportClassification

Returns

OperationClassification if it's an operation, or undefined if it's not

NB: don't confuse this with

ImportClassification

something like src/xxx/xxx/x.ts (no slash at start)

something like src/xxx/xxx/x.ts (no slash at start)

get all operation-related path information that can be inferred from the path

NB: currently it also looks up the operation name from its packagejson

gets all kinds of information that can be inferred from any path (file or folder).

get all operation-related path information that can be inferred from the path

NB: currently it also looks up the operation name from its packagejson

gets all kinds of information that can be inferred from any path (file or folder).

returns a relative link between two files

Checks whether or not an absolute path contains an operation. The only check it's doing is that the folder must contain both a package.json as well as a tsconfig.json

returns a relative link between two files

Checks whether or not an absolute path contains an operation. The only check it's doing is that the folder must contain both a package.json as well as a tsconfig.json

Show test information(2)

test()

Input
-
Output

📄 test (unexported const)

Show internal (24)

findFolderWhereMatch()

recursive. goes up a folder until it finds a package.json

Input
-
Output	{ folderPath: string, matchResult: { }, }

findOperationBasePathWithClassification()

recursive. goes up until it finds a folder that's an operation

because it had to read the package.json anyway, it's returning the operation classification as well

Input
startPath	string
Output	{ folderPath: string, classification: { }, }

getAllPackageJsonDependencies()

Input
operation	Operation Model for typerepo operations. Stored in package.json in every package (compatible with regular npm package.json data structure). An Operation is a NPM Package that applies the typerepo convention. TODO: add a validation to package.json files for the whole project, to ensure i can apply fs-orm convention Operation
Output	string[]

getCommonAncestor()

Finds the common ancestor for two absolute pahts

Input
path1	string
Output	String

getRelativePath()

gets the relative path from a specified root

will start with "/"

Input
absolutePath	string
Output

hasDependency()

Input
operation	Operation Model for typerepo operations. Stored in package.json in every package (compatible with regular npm package.json data structure). An Operation is a NPM Package that applies the typerepo convention. TODO: add a validation to package.json files for the whole project, to ensure i can apply fs-orm convention Operation
Output

isUiOperation()

Input
tsconfig	{ }
Output

isWorkspaceRoot()

simple sync function to check if a folder is the root of a workspace (not operation but a workspace)

Input
folderPath	string
Output	{ isBundle: boolean, isWorkspaceRoot: boolean, }

packageCompilesTs()

Input
packageJson	{ }
Output

tsconfigCompilesEsm()

Input
tsconfig	TsConfig would be nice if we have a type interface for this, just like package.json for now just type the stuff we need TsConfig
Output	{ }

📄 findFolderWhereMatch (exported const)

recursive. goes up a folder until it finds a package.json

📄 findOperationBasePathWithClassification (exported const)

recursive. goes up until it finds a folder that's an operation

because it had to read the package.json anyway, it's returning the operation classification as well

📄 getAllPackageJsonDependencies (exported const)

📄 getCommonAncestor (exported const)

Finds the common ancestor for two absolute pahts

📄 getRelativePath (exported const)

gets the relative path from a specified root

will start with "/"

📄 hasDependency (exported const)

📄 isUiOperation (exported const)

📄 isWorkspaceRoot (exported const)

simple sync function to check if a folder is the root of a workspace (not operation but a workspace)

📄 osRootFoldersConst (exported const)

can only be accessed in the OS

📄 osRootFolders (exported const)

📄 packageCompilesTs (exported const)

📄 projectRootFoldersConst (exported const)

can be accessed in projects as well as in the OS

📄 projectRootFolders (exported const)

📄 tsconfigCompilesEsm (exported const)