Plugin Authoring Example

Start a new plugin that exposes one rule.

Steps

1. Scaffold the project:

   npm init -y
   npm install --save-dev @lapidist/design-lint typescript

2. Create index.ts with a rule:

   export default {
     rules: [{ name: 'demo/no-raw-colors', create: () => ({}) }]
   };

3. Test it:

   import { createLinter, createNodeEnvironment } from '@lapidist/design-lint';
   import plugin from './index.js';
   const config = { plugins: [plugin], rules: { 'demo/no-raw-colors': 'error' } };
   const linter = createLinter(config, createNodeEnvironment(config));

Next steps

Read the plugins guide for a full tutorial.