https://github.com/sngular/javascript

JavaScript Style Guide
https://github.com/sngular/javascript

commitlint eslint javascript prettier semantic-release tsconfig

Last synced: 3 days ago
JSON representation

JavaScript Style Guide

• Host: GitHub
• URL: https://github.com/sngular/javascript
• Owner: sngular
• License: mpl-2.0
• Created: 2024-01-10T07:41:40.000Z (10 months ago)
• Default Branch: main
• Last Pushed: 2024-05-07T10:45:28.000Z (6 months ago)
• Last Synced: 2024-10-12T21:13:40.828Z (about 1 month ago)
• Topics: commitlint, eslint, javascript, prettier, semantic-release, tsconfig
• Language: JavaScript
• Size: 626 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# Javascript quality guidelines

In order to enforcing SNGULAR style guidelines. We created the following packages to help projects implement linters easily.

- [@sngular/commitlint-config](./packages/commitlint/README.md)

- [@sngular/eslint-config](./packages/eslint/README.md)

- [@sngular/lint-staged-config](./packages/lint-staged/README.md)

- [@sngular/prettier-config](./packages/prettier/README.md)

- [@sngular/semantic-release-config](./packages/semantic-release/README.md)

- [@sngular/tsconfig](./packages/tsconfig/README.md)

You can also configure [`.editorconfig`](./.editorconfig) file to ensure your code editor follow the style guide.

Some of the packages (commitlint & lint-staged) are created to work with [husky](https://typicode.github.io/husky/) to make git hook easy. We recommend to follow the [manual installation](https://typicode.github.io/husky/#/?id=manual) and then add the following hooks to your project:

- Hook for lint commit messages:

```bash

npx husky add .husky/commit-msg 'npx --no -- commitlint --edit "$1"'

```

- Hook for lint your files before commit

```bash

npx husky add .husky/pre-commit 'npx --no -- lint-staged'

```