file-name-starts-with

file-name-starts-with

autofixable: no (because autofixing this may result in imports from files that don't exist)

• By default, require that all imported files begin with _.

  "plugin-import/file-name-starts-with": true // same as {"mode": "require", "startWith": "_"}

• Customize startWith character:

  "plugin-import/file-name-starts-with": {
      "mode": "require",
      "startWith": "-" /* require that all imported files start with - */
  }

  "plugin-import/file-name-starts-with": {
      "mode": "block",
      "startWith": "(" /* block any imported files from starting with ( */
  }

Examples

• Defaults:

   "plugin-import/file-name-starts-with": true // same as {"mode": "require", "startWith": "_"}

  • Good

    @import '_colors';

  • Bad

    @import 'colors';

• block mode:

   "plugin-import/file-name-starts-with": {"mode": "block"}

  • Good

    @import 'colors';

  • Bad

    @import '_colors';

• Custom startWith:

   "plugin-import/file-name-starts-with": {"mode": "require", "startWith": "q"}

  • Good

    @import 'q-colors';

  • Bad

    @import 'colors';