This document outlines the various scripts available in this project, categorized for easy navigation and understanding. These scripts automate common development tasks, from documentation generation to code formatting and linting.
-
docs— Generates and updates markdown documentation files. (line 39)npx markdown-magic@3.7.0 **/*.md -c md.config.js
-
format— Formats all code files using Prettier. (line 40)prettier --write . -
format:packagejson— Formats the package.json file using Prettier. (line 41)prettier --write package.json
-
postinstall— Runs after npm install to generate documentation. (line 42)npm run docs
-
postuninstall— Runs after npm uninstall to update documentation. (line 45)npm run docs
-
precommit— Runs docs and format tasks before commit. (line 43)npm run docs && npm run format -
test— Runs tests for the project. (line 44)jest --passWithNoTests