@nyfulcrum/parser-utils v0.3.0

Symple store parser utils

Shared utilities for lambda functions

Environment setup

1. Install Node.js >=v16.13.0.
2. Install yarn with npm install -g yarn.
3. To install JS dependencies, open a terminal and cd <to project root>, then run yarn.

How to build locally?

If you followed the environment setup, you can just run the following:

yarn build

Then check the dist/ folder for the build output.

Contribution Guide

1. Install ESLint Extension for VSCode to see lint errors real-time, any missed lint errors will result in a failed commit.
2. Install CSPell Checker for VSCode to see the spelling errors real-time, add custom words to cspell.json or hover to the spelling error and then select quick fix > add to cspell.json.
3. Follow Conventional Commits, for easier code review and it is used to auto-bump the version on the CI/CD pipeline.
4. Avoid pushing commits having too many files changed just to save time.
5. A single commit should only describe one change, it can be multiple files as long as they are related.

   For example:

   // moduleA.ts
   - export const something = () => 'something';
   + export const saySomething = () => 'something';
   
   // moduleB.ts
   - import {something} from 'src/moduleA';
   - something();
   + import {saySomething} from 'src/moduleA';
   + saySomething();

   Then you can commit this with:

   refactor: rename to saySomething