Skip to content
This repository has been archived by the owner on Mar 20, 2021. It is now read-only.

Latest commit

 

History

History
154 lines (107 loc) · 6.9 KB

README.md

File metadata and controls

154 lines (107 loc) · 6.9 KB
Raw

NOTICE:

This repository has been archived and is not supported.

No Maintenance Intended

NOTICE: SUPPORT FOR THIS PROJECT HAS ENDED

This projected was owned and maintained by Walmart. This project has reached its end of life and Walmart no longer supports this project.

We will no longer be monitoring the issues for this project or reviewing pull requests. You are free to continue using this project under the license terms or forks of this project at your own risk. This project is no longer subject to Walmart's bug bounty program or other security monitoring.

Actions you can take

We recommend you take the following action:

  • Review any configuration files used for build automation and make appropriate updates to remove or replace this project
  • Notify other members of your team and/or organization of this change
  • Notify your security team to help you evaluate alternative options

Forking and transition of ownership

For security reasons, Walmart does not transfer the ownership of our primary repos on Github or other platforms to other individuals/organizations. Further, we do not transfer ownership of packages for public package management systems.

If you would like to fork this package and continue development, you should choose a new name for the project and create your own packages, build automation, etc.

Please review the licensing terms of this project, which continue to be in effect even after decommission.

eslint-config-walmart

A composable set of ESLint configurations.

This project is the maintained offshoot of eslint-config-defaults with just the Walmart Labs-flavored rules included. It is eslint@2+-compatible and actively maintained (with love) by the friendly folks at Walmart Labs. Check out the style guide for a comprehensive list of rules.

Installation

  1. Install this config package and ESLint:

    $ npm install --save-dev eslint eslint-config-walmart

  2. Then, install any additional dependencies required by your configuration. (See Dependencies section below.)

    e.g.
```bash
$ npm install --save-dev eslint-plugin-filenames babel-eslint
```

Usage

Full Configurations

This package includes the following complete and ready to use configurations:

  • walmart - ES6 config
  • walmart/configurations/off - Disable all rules (ESLint's default at 1.0.0+)
  • walmart/configurations/es5-browser - ES5 + browser
  • walmart/configurations/es5-node - ES5 + node < 4.x
  • walmart/configurations/es5-test - ES5 + test
  • walmart/configurations/es5 - ES5 config
  • walmart/configurations/es6-browser - ES6 + browser
  • walmart/configurations/es6-node-test - ES6 + node 4.x + test
  • walmart/configurations/es6-node - ES6 + node 4.x
  • walmart/configurations/es6-react-test - ES6 + react + test
  • walmart/configurations/es6-react - ES6 + react
  • walmart/configurations/es6-test - ES6 + test
  • walmart/configurations/es6 - ES6 config
Dependencies

To consume and extend a config in ESLint just add the extends attribute to your .eslintrc. For more details about how shareable configs work, see the ESLint documentation.

---
"extends":
  - "walmart"
---
"extends":
  - "walmart/configurations/es6-browser"

NOTE: Extending multiple complete configs can cause unexpected results, if you need to do this you should consider a piecemeal config as explained below. See walmartlabs/eslint-config-defaults#38 for details.

Piecemeal Configurations

ESLint configuration is broken apart in ./rules containing ESLint's rules and rules for specific ESLint plugins. The full set of ESLint rules (./rules/eslint) are broken into categories that mirror ESLint's documentation. Under each rule type there are sets of configuration as well as an off.js file which turns off every rule in the category.

Examples
---
"extends":
  - "walmart/rules/eslint/best-practices/on",
  - "walmart/rules/eslint/es6/off"
  - "walmart/rules/eslint/node/off"

"env":
  "phantom": true

Limitations

Due to an issue with ESLint, config extension cannot be called from a globally installed (npm install -g eslint) eslint. It can however be run properly using eslint installed directly to your package's node_modules. This can be done by either calling it directly (./node_modules/.bin/eslint .) or from within an npm script since they automatically check local node_modules first. This will be tracked in issue #43.

This package tracks config in the following versions:

And A Special Thanks To

License

Copyright (c) 2015-present, WalmartLabs

Licensed under the Apache License, Version 2.0.