@handy-common-utils/dev-utils

Tool chain utilities for the convenience of developers.

Node.js version compatibility

• Test cases have been verified with Node.js versions 18, 20, and 22.
• Compilation target is ES2021.
• Compatibility with ES2021 has been checked.

Installation

You can install this package directly as a development dependency:

npm install -D @handy-common-utils/dev-utils

Alternatively, you can add @handy-common-utils/dev-dependencies (which includes this package as a dependency):

npm install -D @handy-common-utils/dev-dependencies

How to use - generating API doc and update README.md

After installation, the command line utility generate-api-docs-and-update-readme will be available in your project. This command updates the `

dev-utils

Re-exports

Functions

• generateApiDocsMd = DevUtils.generateApiDocsMd
• generateApiDocsAndUpdateReadme = DevUtils.generateApiDocsAndUpdateReadme
• getGitInfo = DevUtils.getGitInfo
• loadConfiguration = DevUtils.loadConfiguration
• loadConfigurationWithVariant = DevUtils.loadConfigurationWithVariant

Exports

Classes

| Class | Description | | ------ | ------ | | DevUtils | - |

Interfaces

| Interface | Description | | ------ | ------ | | GitInfo | Git related information. See https://github.com/jacob-meacham/serverless-plugin-git-variables | | LoadConfigurationOptions | Options for loadConfiguration(...) function |

Type Aliases

| Type Alias | Description | | ------ | ------ | | GitInfoKey | - |

Classes

Abstract Class: DevUtils

Constructors

Constructor

new DevUtils(): DevUtils

Returns

DevUtils

Properties

| Property | Modifier | Type | Description | | ------ | ------ | ------ | ------ | | DEFAULT_OPTIONS_FOR_LOAD_CONFIGURATION | readonly | LoadConfigurationOptions | Default options for loadConfiguration(...) |

Methods

generateApiDocsAndUpdateReadme()

static generateApiDocsAndUpdateReadme(readmeLocation?, entryPoints?, apiDocDir?, typeDocOptions?): Promise<void>

Generate API documentation and insert it into README.md file.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | readmeLocation | string | README_MD_FILE | location of the README.md file | | entryPoints | string[] | ... | Entry points for generating API documentation | | apiDocDir | string | API_DOCS_DIR | temporary directory for storing intermediate documentation files | | typeDocOptions? | Partial<Omit<TypeDocOptions, "entryPoints" | "out">> | undefined | Options for TypeDoc |

Returns

Promise<void>

Promise of void

Example

DevUtils.generateApiDocsAndUpdateReadme(readmePath, entryPoints, apiDocDir);

generateApiDocsMd()

static generateApiDocsMd(entryPoints?, apiDocDir?, options?): Promise<void>

Parameters

| Parameter | Type | Default value | | ------ | ------ | ------ | | entryPoints | string[] | ... | | apiDocDir | string | API_DOCS_DIR | | options? | Partial<Omit<TypeDocOptions, "entryPoints" | "out">> | undefined |

Returns

Promise<void>

getGitInfo()

static getGitInfo(whitelistKeys?, checkEnvironmentVariables?, reportErrors?): Promise<Partial<GitInfo>>

Get Git related information. This function relies on the existence of Git command line.

By default all possible information will be returned, but this can be overridden by specifying whitelistKeys argument.

If checkEnvironmentVariables argument is true, then environment variables GIT_COMMIT and GITHUB_SHA will be checked before trying to identify the commit ID from local Git repository, also environment variables GIT_LOCAL_BRANCH, GIT_BRANCH, BRANCH_NAME, GITHUB_REF_NAME will be checked before trying to identify the branch name from local Git repository.

This function never throws Error. For example, if user and email have not been configured, they would be undefined in the returned object.

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | whitelistKeys? | keyof GitInfo[] | undefined | keys (property names) in the returned object that values need to be populated | | checkEnvironmentVariables? | boolean | true | true (default value) if environment variables should be checked | | reportErrors? | boolean | false | true if errors should be reported in the errors: any[] property of the returned object |

Returns

Promise<Partial<GitInfo>>

Git related information

loadConfiguration()

static loadConfiguration<T>(fileNameBase, overrideOptions?): T | undefined

Load configuration from YAML and/or JSON files. This function is capable of reading multiple configuration files from the same directory and optionally its ancestor directories, and combine the configurations.

Internal logic of this function is: \

1. Start from the directory as specified by options.dir (default is ".") \
2. Try to read and parse all the files as specified by ${dir}${options.extensions.<key>} as type options.extensions.<value>
   2.1 Unreadable (non-existing, no permission, etc.) files are ignored
   2.2 File content parsing error would halt the process with an Error
   2.3 Files specified at the top of options.extensions overrides those at the bottom
   2.4 Default configuration in options.extensions is: ".yaml" as YAML, ".yml" as YAML, ".json" as JSON. You can override it. \
3. Find the parent directory, and use options.shouldCheckAncestorDir function to decide if parent directory should be checked.
   3.1 The function won't be called for the starting directory. The first call to this function would be for the parent directory with level=1.
   3.2 If parent directory should be checked, use parent directory and go to step 2
   3.3 Otherwise finish up
   3.4 Default configuration of options.shouldCheckAncestorDir always returns false. You can override it.
   3.4.1 Several parameters are passed to the function: level (the immediate parent directory has the level value 1), basename of the directory, absolute path of the directory, already consolidated/merged configurations, absolute path of the directory containing the last/previous file picked up. \
4. Configurations in child directories override configurations in parent directories. \

Other options:
encoding: encoding used when reading the file, default is 'utf8'
merge: the function for merging configurations, the default implementation uses lodash/merge \

Type Parameters

| Type Parameter | Default type | | ------ | ------ | | T | any |

Parameters

| Parameter | Type | Description | | ------ | ------ | ------ | | fileNameBase | string | Base part of the file name, usually this is the file name without extension, but you can also be creative. | | overrideOptions? | Partial<LoadConfigurationOptions<T>> | Options that would be combined with default options. |

Returns

T | undefined

The combined configuration, or undefined if no configuration file can be found/read.

Example

// Pick up and merge (those to the left overrides those to the right) configurations from: ./my-config.yaml, ./my-config.yml, ./my-config.json
const config = DevUtils.loadConfiguration('my-config');

// Let .json override .yml and don't try to pick up .yaml
const config = DevUtils.loadConfiguration('my-config', { extensions: {
  '.json': 'json',
  '.yml': 'yaml',
} });

// Search in parent, grand parent, and great grand parent directories as well
const config = DevUtils.loadConfiguration(
  'my-config',
  {
    dir: 'test/fixtures/dir_L1/dir_L2/dir_L3/dir_L4',
    shouldCheckAncestorDir: (level, _dirName, _dirAbsolutePath) => level <= 3,
  },
);

loadConfigurationWithVariant()

static loadConfigurationWithVariant<T>(fileNameBase, variant, baseVariant?, overrideOptions?): T | undefined

Load configuration from YAML and/or JSON files with variant suffix. This function is capable of reading multiple configuration files from the same directory and optionally its ancestor directories, and combine the configurations. This function is based on loadConfiguration. It picks up the specified variant configuration and the base variant configuration from a directory and optionally its ancestor directories, then merge them by overriding the base variant configuration with the specified variant configuration.

Type Parameters

| Type Parameter | Default type | | ------ | ------ | | T | any |

Parameters

| Parameter | Type | Default value | Description | | ------ | ------ | ------ | ------ | | fileNameBase | string | undefined | Base part of the file name, for example, my-config, settings. | | variant | string | undefined | Part of the file name that identifies the variant, for example, .staging, -production, _test. When searching for configuration files, it would be inserted between the fileNameBase and the file type suffix. | | baseVariant | string | '.default' | Part of the file name that identifies the base variant. The default value is .default. When searching for configuration files, it would be inserted between the fileNameBase and the file type suffix. | | overrideOptions? | Partial<LoadConfigurationOptions<T>> | undefined | Options that would be combined with default options. |

Returns

T | undefined

The combined configuration, or undefined if no configuration file can be found/read.

Interfaces

Interface: GitInfo

Git related information. See https://github.com/jacob-meacham/serverless-plugin-git-variables

Properties

| Property | Type | Description | | ------ | ------ | ------ | | branch | string | name of the current branch | | commitIdLong | string | hash of the current commit, a.k.a. commit ID, in full | | commitIdShort | string | hash of the current commit, a.k.a. commit ID, in short format | | describe | string | the most recent tag of the repo, evaluates to git describe --always | | describeLight | string | the most recent tag of the repo, evaluates to git describe --always --tags | | email | string | current Git user's email as configured by git config user.email ... | | isDirty | boolean | true if the workspace is currently dirty | | message | string | full git commit message | | messageBody | string | body of the commit message, as git log -1 --pretty=%b | | messageSubject | string | subject of the commit message, as git log -1 --pretty=%s | | repository | string | name of the git repository | | tag | string | First tag on the current commit, or sha1/ID of the commit if there's no tag | | tags | string[] | tags on the current commit, or sha1/ID of the commit if there's no tag | | user | string | current Git user's name as configured by git config user.name ... |

Interface: LoadConfigurationOptions<T>

Options for loadConfiguration(...) function

Type Parameters

| Type Parameter | Default type | | ------ | ------ | | T | any |

Properties

| Property | Type | Description | | ------ | ------ | ------ | | dir | string | In which directory configuration file(s) should be picked up | | encoding | BufferEncoding | Encoding of the configuration files | | extensions | Record<string, keyof typeof configurationParsers> | File extensions that should be picked up. It is an object. For each property, the key is the file extension, the value is the file/parser type. | | merge | (base, override) => T | Function for merging the configurations from different files. It is supposed to merge the object on the right to the object on the left. The function is also supposed to return the modified object on the left. | | shouldCheckAncestorDir | (level, dirName, dirAbsolutePath, consolidatedConfiguration, previousDirAbsolutePath) => boolean | Predicate function for deciding whether configuration files in the ancestor directory should be picked up |

Type Aliases

Type Alias: GitInfoKey

GitInfoKey = keyof GitInfo