asl-19/js-utils

Shared JavaScript utility functions for ASL19 projects

@asl-19/js-utils

Shared JavaScript utility functions for ASL19 projects.

See docs/js-utils.md for API documentation.

Install

npm install @asl-19/js-utils

Development

This package is developed with Node.js 18 (the active LTS release as of 2023-08).

In this folder:

# Watch src and build into dist/cjs and dist/esm on change
npm run dev

If you add a new function or making a change to the arguments of an existing function (without this TypeScript won’t be aware of the changes, and the build-lint-test script will fail):

# Update api-extractor/* (metadata about code generated by api-extractor), docs/* (Markdown documentation generated by api-documenter using api-extractor metadata) and types/js-utils.d.ts (types generated by api-extractor)
npm run api-extractor-update

In a project that uses js-utils:

# Replace project‘s copy of js-utils with local version
npm link /absolute/path/to/js-utils

After running npm link you’ll see something like "@asl-19/js-utils": "file:../../../js-utils" in your project’s package.json, with corresponding changes in package-lock.json. And if you look at the project’s node_modules/@asl-19/js-utils you’ll see that it’s a symlink to the path provided to npm link. This means that any changes built into the dist directory will immediately apply to the project it’s linked into.

Once you’re finished testing make sure you reset your package.json and package-lock.json, then run npm install to revert to the published copy of the package.

js-utils's Issues

constructUrl querySegments with falsy values aren’t excluded

The previous implementation of some of the project-specific copies of this function did this so we should reproduce this behaviour to avoid subtle regressions.

Add API Extractor check to GitHub workflow

Add constructUrl and getNormalizedQuery Jest tests from internetabad

The internetabad project includes Jest tests for constructUrl and getNormalizedQuery. Let’s move them into this project.

Switch to @asl-19/eslint-config

Add eslint-plugin-tsdoc

Upgrade @asl-19/eslint-config-typescript to 0.4.4

Add GitHub workflow

Upgrade @asl-19/eslint-config to 0.2.0

In constructUrl enforce that path starts with "/"

This matches the existing behaviour of at least one of our internal versions’ copies, and should safe in other projects.

README missing installation instructions

Update constructUrl to accept Array<string> and Array<number> querySegments

In one of our internal projects there’s a variant of the function that accepts Array<string> and Array<number>. Let’s update this version of the function to support those querySegments types.

Upgrade dependencies

Add replaceArabicNumeralsWithPersianNumerals