diff --git a/packages/linting/README.md b/packages/linting/README.md index fe76df93..1bcb7bf3 100644 --- a/packages/linting/README.md +++ b/packages/linting/README.md @@ -1 +1,9 @@ -# linting +# VA Design System Mobile ESLint Configuration + +This package contains an ESLint config for use by consumers of the [VA Design System Mobile Component Library](https://www.npmjs.com/package/@department-of-veterans-affairs/mobile-component-library) to automatically issue deprecation notices when outdated components are being used. + +## Getting Started +These steps assume you already have `eslint` installed for your project as a devDependency and configured correctly. +1. Add `eslint-plugin-deprecate` as a devDependency to your project (peerDependency of package) +2. Add `@department-of-veterans-affairs/eslint-config-mobile` as a devDependency to your project +3. In your eslint config file, add to the `extends` attribute: `@department-of-veterans-affairs/mobile` \ No newline at end of file diff --git a/packages/linting/index.js b/packages/linting/index.js index 0d085f41..007ee090 100644 --- a/packages/linting/index.js +++ b/packages/linting/index.js @@ -1,14 +1,8 @@ module.exports = { plugins: ['deprecate'], rules: { - semi: [1, 'always'], 'deprecate/import': [ 'warn', - { - name: 'SegmentedControl', - module: 'components', - use: 'SegmentedControl from @department-of-veterans-affairs/mobile-component-library', - }, { name: 'VAButton', module: 'components',