package
Coding Guidelines for Harper repositories. Includes types, linting, and formatting.
npm install @harperfast/code-guidelinesGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
This repository contains code guideline tools and configurations for the Harper organization.
Currently exports shared configurations for Prettier, ESLint, and TS Node Type Checking. More tools will be added soon.
npm i --save-dev @harperfast/code-guidelines
Add "prettier": "@harperfast/code-guidelines/prettier" to package.json.
Run npx prettier .
We use Prettier for formatting. The default config is exported under the /prettier path (i.e. @harperfast/code-guidelines/prettier).
Review the Sharing Configurations documentation for more information how to use or extend the base config.
We use ESLint to enforce code quality and integrate Prettier formatting. The default config is exported under the /eslint path (i.e. @harperfast/code-guidelines/eslint).
You must create a local ESLint configuration that imports Harper's ESLint configuration, then you can extend or override the base configuration by adding your own rules.
For more detailed information about extending configurations, see the ESLint Configuration Files documentation.
npm i --save-dev @harperfast/code-guidelines eslint prettiereslint.config.mjs file in your project root:import harperConfig from '@harperfast/code-guidelines/eslint';
import { defineConfig } from 'eslint/config';
export default defineConfig([
...harperConfig,
// Your custom configuration here
{
rules: {
// Override or add custom rules
},
},
]);npx eslint .TypeScript configuration files are available under the /tsconfig export path and can be used with the extends property in your own tsconfig.json files.
For example, to use the base Node.js configuration (supporting Node.js v20 or later):
npm i --save-dev typescript @types/node@20 @harperfast/code-guidelinestsconfig.json file in your project with the following content:{
"extends": "@harperfast/code-guidelines/tsconfig.node.json",
"compilerOptions": {
// Your custom options here
}
} npx tsc
# or
node src/index.tsConfigurations are based off of the popular tsconfig bases project.
The following list outlines the available configurations:
tsconfig.node.json - Node.js v20 or later with Node.js Type Stripping supportTo add a new TypeScript configuration:
tsconfig. and ending with .json. The name in between should be descriptive of the environment or relevant version (e.g. tsconfig.react.json or tsconfig.node-24.json).exports field in package.json to include the new configuration file using the same name as the file.harperdb_team
npm@harperdb.io
Estimated unpacked size across 30 packages.
5.8 MB
Includes dependencies.
5 direct · 4 outdated
20.1.6
20.1.11
23.6.1
23.6.5
8.44.0
8.72.2
10.1.8
10.1.8
5.5.7