https://github.com/system76/eslint-config

System76 standard eslint linting configuration
https://github.com/system76/eslint-config

Last synced: about 2 months ago
JSON representation

System76 standard eslint linting configuration

• Host: GitHub
• URL: https://github.com/system76/eslint-config
• Owner: system76
• Created: 2019-03-07T17:04:27.000Z (almost 6 years ago)
• Default Branch: master
• Last Pushed: 2023-03-04T03:18:42.000Z (almost 2 years ago)
• Last Synced: 2024-10-12T21:49:44.772Z (2 months ago)
• Language: JavaScript
• Size: 1.28 MB
• Stars: 5
• Watchers: 6
• Forks: 1
• Open Issues: 10
• Metadata Files:
  • Readme: README.md
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        


  
@system76/eslint-config

  
System76 eslint configuration

  


  






  

    

  

  

    

  

  

    

  

  

    

  



---

This is the System76 eslint configuration. It is based off of

[standard](https://github.com/feross/standard), but includes additional rules

for common libraries and tools we use here at System76. This includes

[ava](https://github.com/avajs/ava), [vue](https://github.com/vuejs/vue), and

some others.

## Using

```

npm install --save-dev @system76/eslint-config

```

Then extend this in your own eslint configuration file:

```js

module.exports = {

  extends: [

    '@system76'

  ]

}

```

Then add these lines to your `package.json` file:

```json

{

  "scripts": {

    "lint:js": "eslint --ext js,vue --ignore-path .gitignore .",

    "lint:js:fix": "eslint --fix --ext js,vue --ignore-path .gitignore ."

  }

}

```

And finally, you can lint with `npm run lint:js`.

## Development

There's not much to it. Aside from the few test files we check, the only file

you need to concern yourself with is the `eslintrc.json` file. If the tests and

linting pass, you are good for a PR!

## Deployment

This repository uses [semantic-release][semantic] to determine the npm version

and when to release. Please ensure your commit messages follow the [Angular

Commit Message Conventions][acmc].

Past that, just push to master and [travis][travis] will take care of the rest.

[semantic]: https://github.com/semantic-release/semantic-release

[acmc]: https://github.com/angular/angular.js/blob/master/DEVELOPERS.md#-git-commit-guidelines

[travis]: https://travis-ci.org/system76/eslint-config