refactor: make plugin name constant

Author: ylemkimon

.eslintrc.js

@@ -18,7 +18,11 @@ module.exports = {
   rules: {
     '@typescript-eslint/indent': ['error', 2, {SwitchCase: 1}],
     'comma-dangle': ['error', 'always-multiline'],
-    'max-len': ['error', {ignoreStrings: true, ignoreUrls: true}],
+    'max-len': ['error', {
+      ignoreStrings: true,
+      ignoreTemplateLiterals: true,
+      ignoreUrls: true,
+    }],
     'no-trailing-spaces': 2,
     'object-shorthand': 2,
     'prefer-template': 2,

src/configs/recommended.ts

@@ -1,6 +1,6 @@
 import { Linter } from 'eslint';
 
-import { WORKFLOW_DIR, WORKFLOW_FILE } from '../util/constants';
+import { PLUGIN_NAME, WORKFLOW_DIR, WORKFLOW_FILE } from '../util/constants';
 
 const ignorePatterns = [
   // ignore other YAML files
@@ -15,11 +15,11 @@ if (WORKFLOW_DIR.startsWith('.')) {
 }
 
 const recommended: Linter.Config = {
-  plugins: ['actions'],
+  plugins: [PLUGIN_NAME],
   ignorePatterns,
   overrides: [{
     files: WORKFLOW_FILE.map(f => `${WORKFLOW_DIR}/${f}`),
-    processor: 'actions/actions',
+    processor: `${PLUGIN_NAME}/actions`,
   }, {
     files: WORKFLOW_FILE.map(f => `${WORKFLOW_DIR}/${f}/**/*.js`),
     env: { // Node.js 12

src/processors/actions.ts

@@ -4,7 +4,7 @@ import { YAMLError, YAMLWarning } from 'yaml/util';
 import { CST } from 'yaml/parse-cst';
 import { Linter } from 'eslint';
 
-import { SCRIPT_ACTIONS } from '../util/constants';
+import { PLUGIN_NAME, SCRIPT_ACTIONS } from '../util/constants';
 import { Delta, Position, Block, ESLintBlock } from '../util/types';
 
 let blocks: Block[] = [];
@@ -114,7 +114,7 @@ function preprocess(text: string): ESLintBlock[] {
         if (script.type !== 'BLOCK_LITERAL') {
           warnings.push({
             name: 'YAMLWarning',
-            message: 'Only a literal block is supported by eslint-plugin-actions',
+            message: `Only a literal block is supported by eslint-plugin-${PLUGIN_NAME}`,
             linePos,
             makePretty: () => null,
           });
@@ -160,7 +160,7 @@ function postprocess(messages: Linter.LintMessage[][]): Linter.LintMessage[] {
   return errors.concat(warnings).map((
     {name, message, linePos}
   ): Linter.LintMessage => ({
-    ruleId: `actions/${name}`,
+    ruleId: `${PLUGIN_NAME}/${name}`,
     severity: name === 'YAMLWarning' ? 1 : 2,
     message: message.split(' at line ')[0], // strip pretty context
     line: linePos && linePos.start.line || 1,

src/util/constants.ts

@@ -1,5 +1,7 @@
 import { Action } from './types';
 
+export const PLUGIN_NAME = 'actions';
+
 export const WORKFLOW_DIR = '.github/workflows';
 export const WORKFLOW_FILE = ['*.yml', '*.yaml'];