Skip to content

Commit

Permalink
Ready for PR
Browse files Browse the repository at this point in the history
  • Loading branch information
TimRoe committed Dec 5, 2023
1 parent f585136 commit 135eb70
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 7 deletions.
10 changes: 9 additions & 1 deletion packages/linting/README.md
Original file line number Diff line number Diff line change
@@ -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`
6 changes: 0 additions & 6 deletions packages/linting/index.js
Original file line number Diff line number Diff line change
@@ -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',
Expand Down

0 comments on commit 135eb70

Please sign in to comment.