Skip to content

Commit

Permalink
Specify babel config file
Browse files Browse the repository at this point in the history
  • Loading branch information
RyanMulready committed Feb 4, 2022
1 parent 090f053 commit f082446
Show file tree
Hide file tree
Showing 3 changed files with 25 additions and 9 deletions.
7 changes: 4 additions & 3 deletions PUBLISH.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
# Publishing to NPM

To publish to npm we use the [np](https://github.com/sindresorhus/np) tool. You must first install it and ensure you are logged into npm and are part of the EnergySage organization on [npmjs.org](https://www.npmjs.com/).

```console
$ npm login
$ npm install -g np
$ np
npm login
npm install -g np
np
```

Your first prompt will be asking for the next [semver](https://docs.npmjs.com/about-semantic-versioning). Please read the link to determine what the next appropriate version bump should be. It will next run `npm test` and ensure all tests have passed. Note: You may need to run `npm install` yourself should the tests fail.
Expand Down
23 changes: 17 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,24 +1,31 @@
# eslint-config-energysage

#### An ESLint/Prettier/Stylelint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) For [EnergySage](https://www.energysage.com) Projects
## An ESLint/Prettier/Stylelint [Shareable Config](http://eslint.org/docs/developer-guide/shareable-configs) For [EnergySage](https://www.energysage.com) Projects

This package provides EnergySage's base ESLint, Prettier & Stylelint rule bases.

## Usage

1. Install the correct versions of each peer package, which are listed by the command:
- Install the correct versions of each peer package, which are listed by the command:

```sh
npm info "eslint-config-energysage@latest" peerDependencies
```

And they can be installed using this command:

```sh
npx install-peerdeps --dev eslint-config-energysage
```
2. Install the latest version of our package

- Install the latest version of our package

```sh
npm install --dev eslint-config-energysage@latest
```
3. Update/Create your `.eslintrc.js` file, ensure there are no duplicate plugin/config entries

- Update/Create your `.eslintrc.js` file, ensure there are no duplicate plugin/config entries

```js
module.exports = {
extends: ['eslint-config-energysage'],
Expand All @@ -27,12 +34,16 @@ npm install --dev eslint-config-energysage@latest
},
};
```
4. Update your `package.json` file, ensure there is no `.prettierrc` file

- Update your `package.json` file, ensure there is no `.prettierrc` file

```json
"prettier": "eslint-config-energysage/prettier",
"scripts": {}
```
5. Update/Create your `stylelint.config.js` file, ensure there are no duplicate plugin/config entries

- Update/Create your `stylelint.config.js` file, ensure there are no duplicate plugin/config entries

```js
module.exports = {
extends: ['eslint-config-energysage/stylelint'],
Expand Down
4 changes: 4 additions & 0 deletions index.js
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ module.exports = {
parserOptions: {
// https://github.com/babel/babel/tree/master/eslint/babel-eslint-parser
parser: '@babel/eslint-parser',
requireConfigFile: false,
babelOptions: {
configFile: './babel.config.js',
},
},
plugins: ['strict-vue', 'vuejs-accessibility'],
extends: [
Expand Down

0 comments on commit f082446

Please sign in to comment.