@lvce-editor/eslint-plugin-github-actions 2.17.0 → 2.18.0

package/dist/index.js

@@ -1,5 +1,7 @@
 import * as parserYAML from 'yaml-eslint-parser';
 import { getSourceCode } from 'eslint-compat-utils';
+import { existsSync } from 'fs';
+import { resolve, relative } from 'path';
 
 const config = {
   ubuntu: ['ubuntu-24.04'],
@@ -12,15 +14,15 @@ const platforms = {
   macos: 'macos'
 };
 const actions = {
-  'actions/checkout': ['actions/checkout@v5'],
-  'actions/setup-node': ['actions/setup-node@v6'],
   'actions/cache': ['actions/cache@v4'],
-  'actions/upload-pages-artifact': ['actions/upload-pages-artifact@v4'],
+  'actions/checkout': ['actions/checkout@v5'],
+  'actions/create-release': ['actions/create-release@v1'],
   'actions/deploy-pages': ['actions/deploy-pages@v4'],
   'actions/download-artifact': ['actions/download-artifact@v6'],
+  'actions/setup-node': ['actions/setup-node@v6'],
+  'actions/setup-python': ['actions/setup-python@v5'],
   'actions/upload-artifact': ['actions/upload-artifact@v5'],
-  'actions/create-release': ['actions/create-release@v1'],
-  'actions/setup-python': ['actions/setup-python@v5']
+  'actions/upload-pages-artifact': ['actions/upload-pages-artifact@v4']
 };
 const npmRegistries = ['https://registry.npmjs.org', 'https://npm.pkg.github.com'];
 const onProperties = ['push', 'pull_request'];
@@ -35,7 +37,7 @@ const permissions$1 = {
 const isSupported = (actions, value) => {
   return actions.includes(value);
 };
-const meta$c = {
+const meta$d = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported action versions'
@@ -45,7 +47,7 @@ const meta$c = {
   },
   fixable: 'code'
 };
-const create$c = context => {
+const create$d = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -76,8 +78,8 @@ const create$c = context => {
 
 const actionVersions = {
   __proto__: null,
-  create: create$c,
-  meta: meta$c
+  create: create$d,
+  meta: meta$d
 };
 
 const parseVersion = value => {
@@ -101,7 +103,7 @@ const isSupportedMacosversion = version => {
 const isSupportedWindowsVersion = version => {
   return config.windows.includes(version);
 };
-const meta$b = {
+const meta$c = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported ci versions'
@@ -110,7 +112,7 @@ const meta$b = {
     unsupportedCiVersion: 'Unsupported ci version: {{value}}'
   }
 };
-const create$b = context => {
+const create$c = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -153,11 +155,11 @@ const create$b = context => {
 
 const ciVersions = {
   __proto__: null,
-  create: create$b,
-  meta: meta$b
+  create: create$c,
+  meta: meta$c
 };
 
-const meta$a = {
+const meta$b = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported fail fast values'
@@ -166,7 +168,7 @@ const meta$a = {
     unsupportedFailFast: 'Unsupported fail fast value: {{value}}'
   }
 };
-const create$a = context => {
+const create$b = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -189,11 +191,11 @@ const create$a = context => {
 
 const failFast = {
   __proto__: null,
-  create: create$a,
-  meta: meta$a
+  create: create$b,
+  meta: meta$b
 };
 
-const meta$9 = {
+const meta$a = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported matrix values'
@@ -202,7 +204,7 @@ const meta$9 = {
     unsupportedMatrix: 'Unsupported matrix value: {{value}}'
   }
 };
-const create$9 = context => {
+const create$a = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -224,11 +226,11 @@ const create$9 = context => {
 
 const matrix = {
   __proto__: null,
-  create: create$9,
-  meta: meta$9
+  create: create$a,
+  meta: meta$a
 };
 
-const meta$8 = {
+const meta$9 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported max parallel values'
@@ -237,7 +239,7 @@ const meta$8 = {
     unsupportedMaxParallel: 'Unsupported max parallel value: {{value}}'
   }
 };
-const create$8 = context => {
+const create$9 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -260,11 +262,11 @@ const create$8 = context => {
 
 const maxParallel = {
   __proto__: null,
-  create: create$8,
-  meta: meta$8
+  create: create$9,
+  meta: meta$9
 };
 
-const meta$7 = {
+const meta$8 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported needs values'
@@ -273,21 +275,68 @@ const meta$7 = {
     unsupportedNeeds: 'Unsupported needs value: {{value}}'
   }
 };
-const create$7 = context => {
+const stringifyValue = node => {
+  if (!node) {
+    return '';
+  }
+  if (node.type === 'YAMLScalar') {
+    return `${node.value}`;
+  }
+  return `${node.type}`;
+};
+const getValidNeeds = node => {
+  const greatGrandParent = node.parent.parent.parent;
+  const validNeeds = [];
+  if (greatGrandParent.type === 'YAMLMapping') {
+    const pairs = greatGrandParent.pairs;
+    for (const pair of pairs) {
+      if (pair.key && pair.key.type === 'YAMLScalar' && typeof pair.key.value === 'string') {
+        validNeeds.push(pair.key.value);
+      }
+    }
+  }
+  return validNeeds;
+};
+const create$8 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
   }
   return {
     YAMLPair(node) {
-      if (node && node.type === 'YAMLPair' && node.key && typeof node.key === 'object' && 'type' in node.key && node.key.type === 'YAMLScalar' && typeof node.key.value === 'string' && node.key.value === 'needs' && node.value && typeof node.value === 'object' && 'type' in node.value && node.value.type !== 'YAMLSequence' && !(node.value.type === 'YAMLScalar' && typeof node.value.value === 'string')) {
-        context.report({
-          node,
-          messageId: 'unsupportedNeeds',
-          data: {
-            value: node.value
+      if (node && node.type === 'YAMLPair' && node.key && typeof node.key === 'object' && 'type' in node.key && node.key.type === 'YAMLScalar' && typeof node.key.value === 'string' && node.key.value === 'needs' && node.value && typeof node.value === 'object' && 'type' in node.value) {
+        if (node.value.type !== 'YAMLSequence') {
+          context.report({
+            node,
+            messageId: 'unsupportedNeeds',
+            data: {
+              value: stringifyValue(node.value)
+            }
+          });
+          return;
+        }
+        const validNeeds = getValidNeeds(node);
+        for (const item of node.value.entries) {
+          if (!item || item.type !== 'YAMLScalar' || typeof item.value !== 'string') {
+            context.report({
+              node,
+              messageId: 'unsupportedNeeds',
+              data: {
+                value: stringifyValue(item)
+              }
+            });
+            continue;
           }
-        });
+          if (!validNeeds.includes(item.value)) {
+            context.report({
+              node,
+              messageId: 'unsupportedNeeds',
+              data: {
+                value: stringifyValue(item)
+              }
+            });
+          }
+        }
       }
     }
   };
@@ -295,11 +344,11 @@ const create$7 = context => {
 
 const needs = {
   __proto__: null,
-  create: create$7,
-  meta: meta$7
+  create: create$8,
+  meta: meta$8
 };
 
-const meta$6 = {
+const meta$7 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported npm registry values'
@@ -308,7 +357,7 @@ const meta$6 = {
     unsupportedNpmRegistry: 'Unsupported npm registry value: {{value}}'
   }
 };
-const create$6 = context => {
+const create$7 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -333,11 +382,11 @@ const create$6 = context => {
 
 const npmRegistry = {
   __proto__: null,
-  create: create$6,
-  meta: meta$6
+  create: create$7,
+  meta: meta$7
 };
 
-const meta$5 = {
+const meta$6 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported npm commands'
@@ -354,7 +403,7 @@ const isSupportedNpmCommand = value => {
   }
   return false;
 };
-const create$5 = context => {
+const create$6 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -382,11 +431,11 @@ const create$5 = context => {
 
 const npm = {
   __proto__: null,
-  create: create$5,
-  meta: meta$5
+  create: create$6,
+  meta: meta$6
 };
 
-const meta$4 = {
+const meta$5 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported on values'
@@ -395,7 +444,7 @@ const meta$4 = {
     unsupportedOn: 'Unsupported on value: {{value}}'
   }
 };
-const create$4 = context => {
+const create$5 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -422,11 +471,11 @@ const create$4 = context => {
 
 const on = {
   __proto__: null,
-  create: create$4,
-  meta: meta$4
+  create: create$5,
+  meta: meta$5
 };
 
-const meta$3 = {
+const meta$4 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported permission values'
@@ -435,7 +484,7 @@ const meta$3 = {
     unsupportedPermission: 'Unsupported permission value: {{value}}'
   }
 };
-const create$3 = context => {
+const create$4 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -477,11 +526,11 @@ const create$3 = context => {
 
 const permissions = {
   __proto__: null,
-  create: create$3,
-  meta: meta$3
+  create: create$4,
+  meta: meta$4
 };
 
-const meta$2 = {
+const meta$3 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported shell values'
@@ -490,7 +539,7 @@ const meta$2 = {
     unsupportedShell: 'Unsupported shell value: {{value}}'
   }
 };
-const create$2 = context => {
+const create$3 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -515,11 +564,11 @@ const create$2 = context => {
 
 const shell = {
   __proto__: null,
-  create: create$2,
-  meta: meta$2
+  create: create$3,
+  meta: meta$3
 };
 
-const meta$1 = {
+const meta$2 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported timeout minute values'
@@ -528,7 +577,7 @@ const meta$1 = {
     unsupportedTimeoutMinutes: 'Unsupported timeout minutes value: {{value}}'
   }
 };
-const create$1 = context => {
+const create$2 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -551,11 +600,11 @@ const create$1 = context => {
 
 const timeoutMinutes = {
   __proto__: null,
-  create: create$1,
-  meta: meta$1
+  create: create$2,
+  meta: meta$2
 };
 
-const meta = {
+const meta$1 = {
   type: 'problem',
   docs: {
     description: 'Disallow unsupported node version file values'
@@ -564,7 +613,7 @@ const meta = {
     unsupportedNodeVersionFile: 'Unsupported node version file value: {{value}}'
   }
 };
-const create = context => {
+const create$1 = context => {
   const sourceCode = getSourceCode(context);
   if (!sourceCode.parserServices?.isYAML) {
     return {};
@@ -588,6 +637,66 @@ const create = context => {
 };
 
 const nodeVersionFile = {
+  __proto__: null,
+  create: create$1,
+  meta: meta$1
+};
+
+const meta = {
+  type: 'problem',
+  docs: {
+    description: 'Disallow non-existing working directories'
+  },
+  messages: {
+    invalidWorkingDirectory: 'Working directory not found: {{value}}',
+    workingDirectoryMustBeOfTypeString: 'Working directory must be of type string'
+  }
+};
+const allowedNonExistingWorkingDirectories = ['dist', '.tmp'];
+const isAllowedNonExistingWorkingDirectory = relativePath => {
+  for (const item of allowedNonExistingWorkingDirectories) {
+    if (relativePath.startsWith(item)) {
+      return true;
+    }
+  }
+  return false;
+};
+const create = context => {
+  const sourceCode = getSourceCode(context);
+  if (!sourceCode.parserServices?.isYAML) {
+    return {};
+  }
+  return {
+    YAMLPair(node) {
+      if (node && node.type === 'YAMLPair' && node.key && typeof node.key === 'object' && 'type' in node.key && node.key.type === 'YAMLScalar' && typeof node.key.value === 'string' && node.key.value === 'working-directory' && node.value && typeof node.value === 'object' && 'type' in node.value && node.value.type === 'YAMLScalar') {
+        const nodeValue = node.value.value;
+        if (typeof nodeValue !== 'string') {
+          context.report({
+            node,
+            messageId: 'workingDirectoryMustBeOfTypeString',
+            data: {
+              value: nodeValue
+            }
+          });
+          return;
+        }
+        const path = resolve(context.cwd, nodeValue);
+        const relativePath = relative(context.cwd, path);
+        if (!isAllowedNonExistingWorkingDirectory(relativePath) && !existsSync(path)) {
+          context.report({
+            node,
+            messageId: 'invalidWorkingDirectory',
+            data: {
+              value: nodeValue
+            }
+          });
+        }
+      }
+    }
+  };
+};
+
+const workingDirectory = {
   __proto__: null,
   create,
   meta
@@ -606,6 +715,7 @@ const plugin = {
     'node-version-file': nodeVersionFile,
     'npm-registry': npmRegistry,
     'timeout-minutes': timeoutMinutes,
+    'working-directory': workingDirectory,
     matrix: matrix,
     needs: needs,
     npm: npm,
@@ -635,7 +745,8 @@ const recommended = [{
     'github-actions/on': 'error',
     'github-actions/permissions': 'off',
     'github-actions/shell': 'error',
-    'github-actions/timeout-minutes': 'error'
+    'github-actions/timeout-minutes': 'error',
+    'github-actions/working-directory': 'error'
   }
 }];
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@lvce-editor/eslint-plugin-github-actions",
-  "version": "2.17.0",
+  "version": "2.18.0",
   "main": "dist/index.js",
   "type": "module",
   "keywords": [],