https://github.com/natterstefan/eslint-config-ns

ESLint config ready to be used in multiple projects. Based on Airbnb's code style with prettier, jest and react support.
https://github.com/natterstefan/eslint-config-ns

eslint eslint-config jest prettier prettier-config prettier-eslint react react-hooks stylelint stylelint-config

Last synced: 3 months ago
JSON representation

ESLint config ready to be used in multiple projects. Based on Airbnb's code style with prettier, jest and react support.

• Host: GitHub
• URL: https://github.com/natterstefan/eslint-config-ns
• Owner: natterstefan
• License: mit
• Created: 2018-05-27T18:13:20.000Z (over 6 years ago)
• Default Branch: main
• Last Pushed: 2023-07-31T19:54:29.000Z (over 1 year ago)
• Last Synced: 2024-10-11T01:04:52.673Z (3 months ago)
• Topics: eslint, eslint-config, jest, prettier, prettier-config, prettier-eslint, react, react-hooks, stylelint, stylelint-config
• Language: JavaScript
• Homepage: https://www.npmjs.com/package/eslint-config-ns
• Size: 1.83 MB
• Stars: 28
• Watchers: 2
• Forks: 12
• Open Issues: 23
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# eslint-config

[![GitHub issues](https://img.shields.io/github/issues/natterstefan/eslint-config-ns)](https://github.com/natterstefan/eslint-config-ns/issues)

[![GitHub stars](https://img.shields.io/github/stars/natterstefan/eslint-config-ns)](https://github.com/natterstefan/eslint-config-ns/stargazers)

[![GitHub license](https://img.shields.io/github/license/natterstefan/eslint-config-ns)](https://github.com/natterstefan/eslint-config-ns/blob/main/LICENSE)

[![Commitizen friendly](https://img.shields.io/badge/commitizen-friendly-brightgreen.svg)](http://commitizen.github.io/cz-cli/)

![natterstefan/eslint-config-ns](./assets/github.png)

## Packages

This monorepo contains multiple packages. Take a look at their READMEs for more

details.

- [eslint-config-ns-base](./packages/eslint-config-ns-base/README.md)

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

- [eslint-config-ns-ts-base](./packages/eslint-config-ns-ts-base/README.md)

- [eslint-config-ns-ts](./packages/eslint-config-ns-ts/README.md)

### How are they related to each other?

### JavaScript

- `eslint-config-ns-base` is the base package for JavaScript projects.

- `eslint-config-ns` extends `eslint-config-ns-base` package and can be used in

  React projects.

### TypeScript

- `eslint-config-ns-ts-base` extends `eslint-config-ns-base` package and is the

  base package for TypeScript projects.

- `eslint-config-ns-ts` is the last one in the chain and extends

  `eslint-config-ns-ts-base` and is best used in React TypeScript projects.

## How to release

This repository uses GitHub Actions

([debug locally](https://github.com/nektos/act)) to create a release and update

the [CHANGELOG](CHANGELOG.md). The implementation is inspired and based on

[github.com/babel/actions](https://github.com/babel/actions/tree/bb571b895aa20aaa3ee4ef58adcde364416acc9a).

Either push the tags after running this command to origin, or run the release

workflow manually on GitHub.

### Manually trigger release

```bash

yarn lerna:version

git push --follow-tags

# wait until GitHub Action finishes and then run

yarn lerna:publish

```

### Manually create Changelog entry

```bash

npx lerna-changelog --from  --to 

```

### Automatically with GitHub Actions

Manually invoke the

[GitHub Action release](https://github.com/natterstefan/eslint-config-ns/actions/workflows/release.yml)

and wait until it finishes.

Once the release was created with GitHub Actions, publish the packages manually

to npm with `yarn lerna:publish`.

Attention: make sure the Pull Requests have labels _before_ you merge them. The

label (e.g. `enhancement` and `bug`) will be used to create the CHANGELOG.

## LICENSE

[MIT](LICENSE)

  

    

      

        

          

          

          Stefan Natter