toolkit-utils v0.0.1-alpha.33

⚠️ This is very much work in progress. The API will be facing breaking changes until it is no longer alpha.

Inspired by "Tools without config", "The Melting Pot of JavaScript", and kcd-scripts.

This library provides utility classes and methods for creating toolkits, used to abstract much of the overhead involved in regular JS and TS tasks, such as testing, linting, formatting, building, etc.

• API
  • Classes
  • Functions
  • Project
    • new Project([options])
    • project.srcDir
    • project.scriptsDir
    • project.configDir
    • project.toolkitName
    • project.toolkitRootDir
    • project.name
    • project.package
    • project.isCompiled
    • project.isTypeScript
    • project.toolkitBin
    • project.availableScripts
    • project.fromRoot(...part) ⇒
    • project.fromToolkitRoot(...part) ⇒
    • project.fromConfigDir(...part) ⇒
    • project.fromScriptsDir(...part) ⇒
    • project.hasAnyDep(deps) ⇒
    • project.envIsSet(name) ⇒
    • project.parseEnv(name, defaultValue) ⇒
    • project.packageHas(jsonPath) ⇒
    • project.packageGet(jsonPath) ⇒
    • project.packageSet(jsonPath, value)
    • project.hasScript(scriptFile) ⇒
    • project.hasAnyFile(fileNames)
    • project.writeFile(fileName, data)
    • project.copyFile(sourceFile, newFile)
    • project.bin(executable)
    • project.getConcurrentlyArgs(scripts, killOthers) ⇒
    • project.executeScriptFile(scriptFile, args)
    • project.executeFromCLI(exit) ⇒
    • project.execute(...executables) ⇒ IScriptResult
  • printHelp(scriptNames)
  • replaceArgumentName(args, names, newName) ⇒

API

Classes

Functions

Project

Kind: global class

• Project
  • new Project([options])
  • .srcDir
  • .scriptsDir
  • .configDir
  • .toolkitName
  • .toolkitRootDir
  • .name
  • .package
  • .isCompiled
  • .isTypeScript
  • .toolkitBin
  • .availableScripts
  • .fromRoot(...part) ⇒
  • .fromToolkitRoot(...part) ⇒
  • .fromConfigDir(...part) ⇒
  • .fromScriptsDir(...part) ⇒
  • .hasAnyDep(deps) ⇒
  • .envIsSet(name) ⇒
  • .parseEnv(name, defaultValue) ⇒
  • .packageHas(jsonPath) ⇒
  • .packageGet(jsonPath) ⇒
  • .packageSet(jsonPath, value)
  • .hasScript(scriptFile) ⇒
  • .hasAnyFile(fileNames)
  • .writeFile(fileName, data)
  • .copyFile(sourceFile, newFile)
  • .bin(executable)
  • .getConcurrentlyArgs(scripts, killOthers) ⇒
  • .executeScriptFile(scriptFile, args)
  • .executeFromCLI(exit) ⇒
  • .execute(...executables) ⇒ IScriptResult

new Project(options)

project.srcDir

Kind: instance property of Project

project.scriptsDir

Kind: instance property of Project

project.configDir

Kind: instance property of Project

project.toolkitName

Kind: instance property of Project

project.toolkitRootDir

Kind: instance property of Project

project.name

Kind: instance property of Project

project.package

Kind: instance property of Project

project.isCompiled

Kind: instance property of Project

project.isTypeScript

Kind: instance property of Project

project.toolkitBin

Kind: instance property of Project

project.availableScripts

Kind: instance property of Project

project.fromRoot(...part) ⇒

Kind: instance method of Project
Returns: Path in root directory.

project.fromToolkitRoot(...part) ⇒

Kind: instance method of Project
Returns: Path in toolkit root directory.

project.fromConfigDir(...part) ⇒

Kind: instance method of Project
Returns: Path in config directory.

project.fromScriptsDir(...part) ⇒

Kind: instance method of Project
Returns: Path in scripts dir.

project.hasAnyDep(deps) ⇒

Kind: instance method of Project
Returns: Boolean value based on the existence of dependency in package.json.

project.envIsSet(name) ⇒

Kind: instance method of Project
Returns: Whether the given environment variable is set.

project.parseEnv(name, defaultValue) ⇒

Kind: instance method of Project
Returns: Environment variable or default value

project.packageHas(jsonPath) ⇒

Kind: instance method of Project
Returns: Whether the given path is in the package file

project.packageGet(jsonPath) ⇒

Kind: instance method of Project
Returns: The value at the given path in the package file

project.packageSet(jsonPath, value)

Kind: instance method of Project

project.hasScript(scriptFile) ⇒

Kind: instance method of Project
Returns: Full path of the script. Null if none is found.

project.hasAnyFile(fileNames)

Kind: instance method of Project

project.writeFile(fileName, data)

Kind: instance method of Project

project.copyFile(sourceFile, newFile)

Kind: instance method of Project

project.bin(executable)

Kind: instance method of Project

project.getConcurrentlyArgs(scripts, killOthers) ⇒

Kind: instance method of Project
Returns:

project.executeScriptFile(scriptFile, args)

Kind: instance method of Project

project.executeFromCLI(exit) ⇒

Kind: instance method of Project
Returns: Result of script

project.execute(...executables) ⇒ IScriptResult

Kind: instance method of Project
Returns: IScriptResult -

Example

// Execute some commands serially and concurrently. Commands in the object are executed concurrently.
// 1. `serial-command-1` is executed first.
// 2. `serial-command-2` is executed second.
// 3. Based on a condition, `serial-command-3` might be executed.
// 4. `build doc command`, `some-other-command`, and `tsc` are executed in parallel. (object keys are names used in logs)
// 5. Lastly, `other-serial-command` is executed.
const result = project.execute(
  ["serial-command-1", ["arg"]],
  "serial-command-2",
  someCondition ? "serial-command-3" : null,
  {
    my-parallel-job: ["build-doc-command", ["arg"],
    my-parallel-task: "some-other-command"
    builder: ["tsc", ["arg"]],
  },
  ["other-serial-command", ["arg"]],
);

printHelp(scriptNames)

Kind: global function

replaceArgumentName(args, names, newName) ⇒

Kind: global function
Returns: An array with the arguments replaced.

Example

const arguments = ["--a", "--b"];
replaceArgumentName(arguments, ["--a"], "--c"); // -> ["--c", "--b"]