eslint-plugin-github-actions-2 1.0.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +7 -0
- package/LICENSE +21 -0
- package/README.md +164 -0
- package/dist/_internal/case-police-dictionary.d.ts +10 -0
- package/dist/_internal/case-police-dictionary.d.ts.map +1 -0
- package/dist/_internal/case-police-dictionary.js +486 -0
- package/dist/_internal/case-police-dictionary.js.map +1 -0
- package/dist/_internal/casing.d.ts +17 -0
- package/dist/_internal/casing.d.ts.map +1 -0
- package/dist/_internal/casing.js +197 -0
- package/dist/_internal/casing.js.map +1 -0
- package/dist/_internal/github-actions-config-references.d.ts +16 -0
- package/dist/_internal/github-actions-config-references.d.ts.map +1 -0
- package/dist/_internal/github-actions-config-references.js +76 -0
- package/dist/_internal/github-actions-config-references.js.map +1 -0
- package/dist/_internal/github-actions-trigger-events.d.ts +13 -0
- package/dist/_internal/github-actions-trigger-events.d.ts.map +1 -0
- package/dist/_internal/github-actions-trigger-events.js +47 -0
- package/dist/_internal/github-actions-trigger-events.js.map +1 -0
- package/dist/_internal/github-expressions.d.ts +9 -0
- package/dist/_internal/github-expressions.d.ts.map +1 -0
- package/dist/_internal/github-expressions.js +87 -0
- package/dist/_internal/github-expressions.js.map +1 -0
- package/dist/_internal/lint-targets.d.ts +21 -0
- package/dist/_internal/lint-targets.d.ts.map +1 -0
- package/dist/_internal/lint-targets.js +60 -0
- package/dist/_internal/lint-targets.js.map +1 -0
- package/dist/_internal/rule-docs.d.ts +16 -0
- package/dist/_internal/rule-docs.d.ts.map +1 -0
- package/dist/_internal/rule-docs.js +2 -0
- package/dist/_internal/rule-docs.js.map +1 -0
- package/dist/_internal/rules-registry.d.ts +145 -0
- package/dist/_internal/rules-registry.d.ts.map +1 -0
- package/dist/_internal/rules-registry.js +144 -0
- package/dist/_internal/rules-registry.js.map +1 -0
- package/dist/_internal/workflow-template-properties.d.ts +20 -0
- package/dist/_internal/workflow-template-properties.d.ts.map +1 -0
- package/dist/_internal/workflow-template-properties.js +44 -0
- package/dist/_internal/workflow-template-properties.js.map +1 -0
- package/dist/_internal/workflow-yaml.d.ts +47 -0
- package/dist/_internal/workflow-yaml.d.ts.map +1 -0
- package/dist/_internal/workflow-yaml.js +140 -0
- package/dist/_internal/workflow-yaml.js.map +1 -0
- package/dist/_internal/yaml-traversal.d.ts +10 -0
- package/dist/_internal/yaml-traversal.d.ts.map +1 -0
- package/dist/_internal/yaml-traversal.js +38 -0
- package/dist/_internal/yaml-traversal.js.map +1 -0
- package/dist/plugin.cjs +7107 -0
- package/dist/plugin.cjs.map +7 -0
- package/dist/plugin.d.cts +34 -0
- package/dist/plugin.d.ts +34 -0
- package/dist/plugin.d.ts.map +1 -0
- package/dist/plugin.js +122 -0
- package/dist/plugin.js.map +1 -0
- package/dist/rules/action-name-casing.d.ts +9 -0
- package/dist/rules/action-name-casing.d.ts.map +1 -0
- package/dist/rules/action-name-casing.js +141 -0
- package/dist/rules/action-name-casing.js.map +1 -0
- package/dist/rules/job-id-casing.d.ts +9 -0
- package/dist/rules/job-id-casing.d.ts.map +1 -0
- package/dist/rules/job-id-casing.js +123 -0
- package/dist/rules/job-id-casing.js.map +1 -0
- package/dist/rules/max-jobs-per-action.d.ts +9 -0
- package/dist/rules/max-jobs-per-action.d.ts.map +1 -0
- package/dist/rules/max-jobs-per-action.js +61 -0
- package/dist/rules/max-jobs-per-action.js.map +1 -0
- package/dist/rules/no-case-insensitive-input-id-collision.d.ts +9 -0
- package/dist/rules/no-case-insensitive-input-id-collision.d.ts.map +1 -0
- package/dist/rules/no-case-insensitive-input-id-collision.js +66 -0
- package/dist/rules/no-case-insensitive-input-id-collision.js.map +1 -0
- package/dist/rules/no-composite-input-env-access.d.ts +9 -0
- package/dist/rules/no-composite-input-env-access.d.ts.map +1 -0
- package/dist/rules/no-composite-input-env-access.js +62 -0
- package/dist/rules/no-composite-input-env-access.js.map +1 -0
- package/dist/rules/no-deprecated-node-runtime.d.ts +9 -0
- package/dist/rules/no-deprecated-node-runtime.d.ts.map +1 -0
- package/dist/rules/no-deprecated-node-runtime.js +59 -0
- package/dist/rules/no-deprecated-node-runtime.js.map +1 -0
- package/dist/rules/no-duplicate-composite-step-id.d.ts +9 -0
- package/dist/rules/no-duplicate-composite-step-id.d.ts.map +1 -0
- package/dist/rules/no-duplicate-composite-step-id.js +74 -0
- package/dist/rules/no-duplicate-composite-step-id.js.map +1 -0
- package/dist/rules/no-empty-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-empty-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-empty-template-file-pattern.js +49 -0
- package/dist/rules/no-empty-template-file-pattern.js.map +1 -0
- package/dist/rules/no-external-job.d.ts +9 -0
- package/dist/rules/no-external-job.d.ts.map +1 -0
- package/dist/rules/no-external-job.js +49 -0
- package/dist/rules/no-external-job.js.map +1 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.d.ts +9 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.d.ts.map +1 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.js +54 -0
- package/dist/rules/no-hardcoded-default-branch-in-template.js.map +1 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.d.ts +9 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.d.ts.map +1 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.js +54 -0
- package/dist/rules/no-icon-file-extension-in-template-icon-name.js.map +1 -0
- package/dist/rules/no-inherit-secrets.d.ts +9 -0
- package/dist/rules/no-inherit-secrets.d.ts.map +1 -0
- package/dist/rules/no-inherit-secrets.js +57 -0
- package/dist/rules/no-inherit-secrets.js.map +1 -0
- package/dist/rules/no-invalid-concurrency-context.d.ts +9 -0
- package/dist/rules/no-invalid-concurrency-context.d.ts.map +1 -0
- package/dist/rules/no-invalid-concurrency-context.js +141 -0
- package/dist/rules/no-invalid-concurrency-context.js.map +1 -0
- package/dist/rules/no-invalid-key.d.ts +9 -0
- package/dist/rules/no-invalid-key.d.ts.map +1 -0
- package/dist/rules/no-invalid-key.js +152 -0
- package/dist/rules/no-invalid-key.js.map +1 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.d.ts +9 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.d.ts.map +1 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.js +73 -0
- package/dist/rules/no-invalid-reusable-workflow-job-key.js.map +1 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.d.ts +9 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.d.ts.map +1 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.js +58 -0
- package/dist/rules/no-invalid-template-file-pattern-regex.js.map +1 -0
- package/dist/rules/no-invalid-workflow-call-output-value.d.ts +9 -0
- package/dist/rules/no-invalid-workflow-call-output-value.d.ts.map +1 -0
- package/dist/rules/no-invalid-workflow-call-output-value.js +99 -0
- package/dist/rules/no-invalid-workflow-call-output-value.js.map +1 -0
- package/dist/rules/no-path-separators-in-template-icon-name.d.ts +9 -0
- package/dist/rules/no-path-separators-in-template-icon-name.d.ts.map +1 -0
- package/dist/rules/no-path-separators-in-template-icon-name.js +52 -0
- package/dist/rules/no-path-separators-in-template-icon-name.js.map +1 -0
- package/dist/rules/no-post-if-without-post.d.ts +9 -0
- package/dist/rules/no-post-if-without-post.d.ts.map +1 -0
- package/dist/rules/no-post-if-without-post.js +52 -0
- package/dist/rules/no-post-if-without-post.js.map +1 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.d.ts +12 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.d.ts.map +1 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.js +89 -0
- package/dist/rules/no-pr-head-checkout-in-pull-request-target.js.map +1 -0
- package/dist/rules/no-pre-if-without-pre.d.ts +9 -0
- package/dist/rules/no-pre-if-without-pre.d.ts.map +1 -0
- package/dist/rules/no-pre-if-without-pre.js +51 -0
- package/dist/rules/no-pre-if-without-pre.js.map +1 -0
- package/dist/rules/no-required-input-with-default.d.ts +9 -0
- package/dist/rules/no-required-input-with-default.d.ts.map +1 -0
- package/dist/rules/no-required-input-with-default.js +68 -0
- package/dist/rules/no-required-input-with-default.js.map +1 -0
- package/dist/rules/no-secrets-in-if.d.ts +9 -0
- package/dist/rules/no-secrets-in-if.d.ts.map +1 -0
- package/dist/rules/no-secrets-in-if.js +84 -0
- package/dist/rules/no-secrets-in-if.js.map +1 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.d.ts +9 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.d.ts.map +1 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.js +93 -0
- package/dist/rules/no-self-hosted-runner-on-fork-pr-events.js.map +1 -0
- package/dist/rules/no-subdirectory-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-subdirectory-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-subdirectory-template-file-pattern.js +52 -0
- package/dist/rules/no-subdirectory-template-file-pattern.js.map +1 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.d.ts +9 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.d.ts.map +1 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.js +55 -0
- package/dist/rules/no-template-placeholder-in-non-template-workflow.js.map +1 -0
- package/dist/rules/no-top-level-env.d.ts +9 -0
- package/dist/rules/no-top-level-env.d.ts.map +1 -0
- package/dist/rules/no-top-level-env.js +42 -0
- package/dist/rules/no-top-level-env.js.map +1 -0
- package/dist/rules/no-top-level-permissions.d.ts +9 -0
- package/dist/rules/no-top-level-permissions.d.ts.map +1 -0
- package/dist/rules/no-top-level-permissions.js +39 -0
- package/dist/rules/no-top-level-permissions.js.map +1 -0
- package/dist/rules/no-universal-template-file-pattern.d.ts +9 -0
- package/dist/rules/no-universal-template-file-pattern.d.ts.map +1 -0
- package/dist/rules/no-universal-template-file-pattern.js +60 -0
- package/dist/rules/no-universal-template-file-pattern.js.map +1 -0
- package/dist/rules/no-unknown-input-reference-in-composite.d.ts +9 -0
- package/dist/rules/no-unknown-input-reference-in-composite.d.ts.map +1 -0
- package/dist/rules/no-unknown-input-reference-in-composite.js +80 -0
- package/dist/rules/no-unknown-input-reference-in-composite.js.map +1 -0
- package/dist/rules/no-unknown-job-output-reference.d.ts +9 -0
- package/dist/rules/no-unknown-job-output-reference.d.ts.map +1 -0
- package/dist/rules/no-unknown-job-output-reference.js +229 -0
- package/dist/rules/no-unknown-job-output-reference.js.map +1 -0
- package/dist/rules/no-unknown-step-reference.d.ts +9 -0
- package/dist/rules/no-unknown-step-reference.d.ts.map +1 -0
- package/dist/rules/no-unknown-step-reference.js +133 -0
- package/dist/rules/no-unknown-step-reference.js.map +1 -0
- package/dist/rules/no-untrusted-input-in-run.d.ts +9 -0
- package/dist/rules/no-untrusted-input-in-run.d.ts.map +1 -0
- package/dist/rules/no-untrusted-input-in-run.js +115 -0
- package/dist/rules/no-untrusted-input-in-run.js.map +1 -0
- package/dist/rules/no-unused-input-in-composite.d.ts +9 -0
- package/dist/rules/no-unused-input-in-composite.d.ts.map +1 -0
- package/dist/rules/no-unused-input-in-composite.js +78 -0
- package/dist/rules/no-unused-input-in-composite.js.map +1 -0
- package/dist/rules/no-write-all-permissions.d.ts +9 -0
- package/dist/rules/no-write-all-permissions.d.ts.map +1 -0
- package/dist/rules/no-write-all-permissions.js +61 -0
- package/dist/rules/no-write-all-permissions.js.map +1 -0
- package/dist/rules/pin-action-shas.d.ts +12 -0
- package/dist/rules/pin-action-shas.d.ts.map +1 -0
- package/dist/rules/pin-action-shas.js +100 -0
- package/dist/rules/pin-action-shas.js.map +1 -0
- package/dist/rules/prefer-action-yml.d.ts +9 -0
- package/dist/rules/prefer-action-yml.d.ts.map +1 -0
- package/dist/rules/prefer-action-yml.js +37 -0
- package/dist/rules/prefer-action-yml.js.map +1 -0
- package/dist/rules/prefer-fail-fast.d.ts +9 -0
- package/dist/rules/prefer-fail-fast.d.ts.map +1 -0
- package/dist/rules/prefer-fail-fast.js +61 -0
- package/dist/rules/prefer-fail-fast.js.map +1 -0
- package/dist/rules/prefer-file-extension.d.ts +9 -0
- package/dist/rules/prefer-file-extension.d.ts.map +1 -0
- package/dist/rules/prefer-file-extension.js +104 -0
- package/dist/rules/prefer-file-extension.js.map +1 -0
- package/dist/rules/prefer-inputs-context.d.ts +9 -0
- package/dist/rules/prefer-inputs-context.d.ts.map +1 -0
- package/dist/rules/prefer-inputs-context.js +91 -0
- package/dist/rules/prefer-inputs-context.js.map +1 -0
- package/dist/rules/prefer-step-uses-style.d.ts +9 -0
- package/dist/rules/prefer-step-uses-style.d.ts.map +1 -0
- package/dist/rules/prefer-step-uses-style.js +209 -0
- package/dist/rules/prefer-step-uses-style.js.map +1 -0
- package/dist/rules/prefer-template-yml-extension.d.ts +9 -0
- package/dist/rules/prefer-template-yml-extension.d.ts.map +1 -0
- package/dist/rules/prefer-template-yml-extension.js +41 -0
- package/dist/rules/prefer-template-yml-extension.js.map +1 -0
- package/dist/rules/require-action-name.d.ts +9 -0
- package/dist/rules/require-action-name.d.ts.map +1 -0
- package/dist/rules/require-action-name.js +57 -0
- package/dist/rules/require-action-name.js.map +1 -0
- package/dist/rules/require-action-run-name.d.ts +9 -0
- package/dist/rules/require-action-run-name.d.ts.map +1 -0
- package/dist/rules/require-action-run-name.js +56 -0
- package/dist/rules/require-action-run-name.js.map +1 -0
- package/dist/rules/require-checkout-before-local-action.d.ts +9 -0
- package/dist/rules/require-checkout-before-local-action.d.ts.map +1 -0
- package/dist/rules/require-checkout-before-local-action.js +74 -0
- package/dist/rules/require-checkout-before-local-action.js.map +1 -0
- package/dist/rules/require-composite-step-name.d.ts +9 -0
- package/dist/rules/require-composite-step-name.d.ts.map +1 -0
- package/dist/rules/require-composite-step-name.js +67 -0
- package/dist/rules/require-composite-step-name.js.map +1 -0
- package/dist/rules/require-job-name.d.ts +9 -0
- package/dist/rules/require-job-name.d.ts.map +1 -0
- package/dist/rules/require-job-name.js +70 -0
- package/dist/rules/require-job-name.js.map +1 -0
- package/dist/rules/require-job-step-name.d.ts +9 -0
- package/dist/rules/require-job-step-name.d.ts.map +1 -0
- package/dist/rules/require-job-step-name.js +71 -0
- package/dist/rules/require-job-step-name.js.map +1 -0
- package/dist/rules/require-job-timeout-minutes.d.ts +9 -0
- package/dist/rules/require-job-timeout-minutes.d.ts.map +1 -0
- package/dist/rules/require-job-timeout-minutes.js +99 -0
- package/dist/rules/require-job-timeout-minutes.js.map +1 -0
- package/dist/rules/require-merge-group-trigger.d.ts +9 -0
- package/dist/rules/require-merge-group-trigger.d.ts.map +1 -0
- package/dist/rules/require-merge-group-trigger.js +65 -0
- package/dist/rules/require-merge-group-trigger.js.map +1 -0
- package/dist/rules/require-pull-request-target-branches.d.ts +9 -0
- package/dist/rules/require-pull-request-target-branches.d.ts.map +1 -0
- package/dist/rules/require-pull-request-target-branches.js +102 -0
- package/dist/rules/require-pull-request-target-branches.js.map +1 -0
- package/dist/rules/require-run-step-shell.d.ts +9 -0
- package/dist/rules/require-run-step-shell.d.ts.map +1 -0
- package/dist/rules/require-run-step-shell.js +114 -0
- package/dist/rules/require-run-step-shell.js.map +1 -0
- package/dist/rules/require-template-categories.d.ts +9 -0
- package/dist/rules/require-template-categories.d.ts.map +1 -0
- package/dist/rules/require-template-categories.js +55 -0
- package/dist/rules/require-template-categories.js.map +1 -0
- package/dist/rules/require-template-file-patterns.d.ts +9 -0
- package/dist/rules/require-template-file-patterns.d.ts.map +1 -0
- package/dist/rules/require-template-file-patterns.js +55 -0
- package/dist/rules/require-template-file-patterns.js.map +1 -0
- package/dist/rules/require-template-icon-file-exists.d.ts +9 -0
- package/dist/rules/require-template-icon-file-exists.d.ts.map +1 -0
- package/dist/rules/require-template-icon-file-exists.js +61 -0
- package/dist/rules/require-template-icon-file-exists.js.map +1 -0
- package/dist/rules/require-template-icon-name.d.ts +9 -0
- package/dist/rules/require-template-icon-name.d.ts.map +1 -0
- package/dist/rules/require-template-icon-name.js +48 -0
- package/dist/rules/require-template-icon-name.js.map +1 -0
- package/dist/rules/require-template-workflow-name.d.ts +9 -0
- package/dist/rules/require-template-workflow-name.d.ts.map +1 -0
- package/dist/rules/require-template-workflow-name.js +48 -0
- package/dist/rules/require-template-workflow-name.js.map +1 -0
- package/dist/rules/require-trigger-types.d.ts +9 -0
- package/dist/rules/require-trigger-types.d.ts.map +1 -0
- package/dist/rules/require-trigger-types.js +126 -0
- package/dist/rules/require-trigger-types.js.map +1 -0
- package/dist/rules/require-workflow-call-input-type.d.ts +9 -0
- package/dist/rules/require-workflow-call-input-type.d.ts.map +1 -0
- package/dist/rules/require-workflow-call-input-type.js +89 -0
- package/dist/rules/require-workflow-call-input-type.js.map +1 -0
- package/dist/rules/require-workflow-call-output-value.d.ts +9 -0
- package/dist/rules/require-workflow-call-output-value.d.ts.map +1 -0
- package/dist/rules/require-workflow-call-output-value.js +79 -0
- package/dist/rules/require-workflow-call-output-value.js.map +1 -0
- package/dist/rules/require-workflow-concurrency.d.ts +9 -0
- package/dist/rules/require-workflow-concurrency.d.ts.map +1 -0
- package/dist/rules/require-workflow-concurrency.js +157 -0
- package/dist/rules/require-workflow-concurrency.js.map +1 -0
- package/dist/rules/require-workflow-dispatch-input-type.d.ts +9 -0
- package/dist/rules/require-workflow-dispatch-input-type.d.ts.map +1 -0
- package/dist/rules/require-workflow-dispatch-input-type.js +80 -0
- package/dist/rules/require-workflow-dispatch-input-type.js.map +1 -0
- package/dist/rules/require-workflow-interface-description.d.ts +9 -0
- package/dist/rules/require-workflow-interface-description.d.ts.map +1 -0
- package/dist/rules/require-workflow-interface-description.js +98 -0
- package/dist/rules/require-workflow-interface-description.js.map +1 -0
- package/dist/rules/require-workflow-permissions.d.ts +9 -0
- package/dist/rules/require-workflow-permissions.d.ts.map +1 -0
- package/dist/rules/require-workflow-permissions.js +83 -0
- package/dist/rules/require-workflow-permissions.js.map +1 -0
- package/dist/rules/require-workflow-run-branches.d.ts +9 -0
- package/dist/rules/require-workflow-run-branches.d.ts.map +1 -0
- package/dist/rules/require-workflow-run-branches.js +84 -0
- package/dist/rules/require-workflow-run-branches.js.map +1 -0
- package/dist/rules/require-workflow-template-pair.d.ts +9 -0
- package/dist/rules/require-workflow-template-pair.d.ts.map +1 -0
- package/dist/rules/require-workflow-template-pair.js +47 -0
- package/dist/rules/require-workflow-template-pair.js.map +1 -0
- package/dist/rules/require-workflow-template-properties-pair.d.ts +9 -0
- package/dist/rules/require-workflow-template-properties-pair.d.ts.map +1 -0
- package/dist/rules/require-workflow-template-properties-pair.js +49 -0
- package/dist/rules/require-workflow-template-properties-pair.js.map +1 -0
- package/dist/rules/valid-timeout-minutes.d.ts +9 -0
- package/dist/rules/valid-timeout-minutes.d.ts.map +1 -0
- package/dist/rules/valid-timeout-minutes.js +255 -0
- package/dist/rules/valid-timeout-minutes.js.map +1 -0
- package/dist/rules/valid-trigger-events.d.ts +9 -0
- package/dist/rules/valid-trigger-events.d.ts.map +1 -0
- package/dist/rules/valid-trigger-events.js +100 -0
- package/dist/rules/valid-trigger-events.js.map +1 -0
- package/docs/rules/action-name-casing.md +64 -0
- package/docs/rules/getting-started.md +46 -0
- package/docs/rules/job-id-casing.md +73 -0
- package/docs/rules/max-jobs-per-action.md +79 -0
- package/docs/rules/no-case-insensitive-input-id-collision.md +63 -0
- package/docs/rules/no-composite-input-env-access.md +66 -0
- package/docs/rules/no-deprecated-node-runtime.md +61 -0
- package/docs/rules/no-duplicate-composite-step-id.md +73 -0
- package/docs/rules/no-empty-template-file-pattern.md +57 -0
- package/docs/rules/no-external-job.md +66 -0
- package/docs/rules/no-hardcoded-default-branch-in-template.md +63 -0
- package/docs/rules/no-icon-file-extension-in-template-icon-name.md +57 -0
- package/docs/rules/no-inherit-secrets.md +65 -0
- package/docs/rules/no-invalid-concurrency-context.md +101 -0
- package/docs/rules/no-invalid-key.md +86 -0
- package/docs/rules/no-invalid-reusable-workflow-job-key.md +74 -0
- package/docs/rules/no-invalid-template-file-pattern-regex.md +57 -0
- package/docs/rules/no-invalid-workflow-call-output-value.md +80 -0
- package/docs/rules/no-path-separators-in-template-icon-name.md +57 -0
- package/docs/rules/no-post-if-without-post.md +64 -0
- package/docs/rules/no-pr-head-checkout-in-pull-request-target.md +83 -0
- package/docs/rules/no-pre-if-without-pre.md +64 -0
- package/docs/rules/no-required-input-with-default.md +64 -0
- package/docs/rules/no-secrets-in-if.md +70 -0
- package/docs/rules/no-self-hosted-runner-on-fork-pr-events.md +75 -0
- package/docs/rules/no-subdirectory-template-file-pattern.md +57 -0
- package/docs/rules/no-template-placeholder-in-non-template-workflow.md +63 -0
- package/docs/rules/no-top-level-env.md +64 -0
- package/docs/rules/no-top-level-permissions.md +64 -0
- package/docs/rules/no-universal-template-file-pattern.md +57 -0
- package/docs/rules/no-unknown-input-reference-in-composite.md +71 -0
- package/docs/rules/no-unknown-job-output-reference.md +88 -0
- package/docs/rules/no-unknown-step-reference.md +73 -0
- package/docs/rules/no-untrusted-input-in-run.md +74 -0
- package/docs/rules/no-unused-input-in-composite.md +71 -0
- package/docs/rules/no-write-all-permissions.md +60 -0
- package/docs/rules/overview.md +91 -0
- package/docs/rules/pin-action-shas.md +65 -0
- package/docs/rules/prefer-action-yml.md +57 -0
- package/docs/rules/prefer-fail-fast.md +72 -0
- package/docs/rules/prefer-file-extension.md +77 -0
- package/docs/rules/prefer-inputs-context.md +84 -0
- package/docs/rules/prefer-step-uses-style.md +70 -0
- package/docs/rules/prefer-template-yml-extension.md +57 -0
- package/docs/rules/presets/action-metadata.md +18 -0
- package/docs/rules/presets/all.md +76 -0
- package/docs/rules/presets/index.md +100 -0
- package/docs/rules/presets/recommended.md +26 -0
- package/docs/rules/presets/security.md +16 -0
- package/docs/rules/presets/strict.md +48 -0
- package/docs/rules/presets/workflow-template-properties.md +18 -0
- package/docs/rules/presets/workflow-templates.md +22 -0
- package/docs/rules/require-action-name.md +61 -0
- package/docs/rules/require-action-run-name.md +63 -0
- package/docs/rules/require-checkout-before-local-action.md +66 -0
- package/docs/rules/require-composite-step-name.md +66 -0
- package/docs/rules/require-job-name.md +63 -0
- package/docs/rules/require-job-step-name.md +69 -0
- package/docs/rules/require-job-timeout-minutes.md +76 -0
- package/docs/rules/require-merge-group-trigger.md +67 -0
- package/docs/rules/require-pull-request-target-branches.md +79 -0
- package/docs/rules/require-run-step-shell.md +85 -0
- package/docs/rules/require-template-categories.md +62 -0
- package/docs/rules/require-template-file-patterns.md +63 -0
- package/docs/rules/require-template-icon-file-exists.md +61 -0
- package/docs/rules/require-template-icon-name.md +57 -0
- package/docs/rules/require-template-workflow-name.md +60 -0
- package/docs/rules/require-trigger-types.md +76 -0
- package/docs/rules/require-workflow-call-input-type.md +70 -0
- package/docs/rules/require-workflow-call-output-value.md +67 -0
- package/docs/rules/require-workflow-concurrency.md +73 -0
- package/docs/rules/require-workflow-dispatch-input-type.md +70 -0
- package/docs/rules/require-workflow-interface-description.md +96 -0
- package/docs/rules/require-workflow-permissions.md +75 -0
- package/docs/rules/require-workflow-run-branches.md +66 -0
- package/docs/rules/require-workflow-template-pair.md +58 -0
- package/docs/rules/require-workflow-template-properties-pair.md +58 -0
- package/docs/rules/valid-timeout-minutes.md +74 -0
- package/docs/rules/valid-trigger-events.md +62 -0
- package/package.json +497 -0
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Determine whether a permissions node is the broad `write-all` shortcut. */
|
|
3
|
+
const isWriteAllPermissionsValue = (permissionsPair) => getScalarStringValue(permissionsPair.value)?.trim().toLowerCase() ===
|
|
4
|
+
"write-all";
|
|
5
|
+
/** Rule implementation for disallowing `permissions: write-all`. */
|
|
6
|
+
const rule = {
|
|
7
|
+
create(context) {
|
|
8
|
+
const reportWriteAll = (permissionsPair, scope) => {
|
|
9
|
+
context.report({
|
|
10
|
+
data: {
|
|
11
|
+
scope,
|
|
12
|
+
},
|
|
13
|
+
messageId: "writeAllPermissions",
|
|
14
|
+
node: permissionsPair.value,
|
|
15
|
+
});
|
|
16
|
+
};
|
|
17
|
+
return {
|
|
18
|
+
Program() {
|
|
19
|
+
const root = getWorkflowRoot(context);
|
|
20
|
+
if (root === null) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
const workflowPermissionsPair = getMappingPair(root, "permissions");
|
|
24
|
+
if (workflowPermissionsPair !== null &&
|
|
25
|
+
isWriteAllPermissionsValue(workflowPermissionsPair)) {
|
|
26
|
+
reportWriteAll(workflowPermissionsPair, "top-level workflow `permissions`");
|
|
27
|
+
}
|
|
28
|
+
for (const job of getWorkflowJobs(root)) {
|
|
29
|
+
const jobPermissionsPair = getMappingPair(job.mapping, "permissions");
|
|
30
|
+
if (jobPermissionsPair !== null &&
|
|
31
|
+
isWriteAllPermissionsValue(jobPermissionsPair)) {
|
|
32
|
+
reportWriteAll(jobPermissionsPair, `job '${job.id}' permissions`);
|
|
33
|
+
}
|
|
34
|
+
}
|
|
35
|
+
},
|
|
36
|
+
};
|
|
37
|
+
},
|
|
38
|
+
meta: {
|
|
39
|
+
docs: {
|
|
40
|
+
configs: [
|
|
41
|
+
"github-actions.configs.all",
|
|
42
|
+
"github-actions.configs.recommended",
|
|
43
|
+
"github-actions.configs.security",
|
|
44
|
+
"github-actions.configs.strict",
|
|
45
|
+
],
|
|
46
|
+
description: "disallow `permissions: write-all` so workflows and jobs keep GitHub token scopes least-privileged.",
|
|
47
|
+
recommended: true,
|
|
48
|
+
requiresTypeChecking: false,
|
|
49
|
+
ruleId: "R023",
|
|
50
|
+
ruleNumber: 23,
|
|
51
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/no-write-all-permissions",
|
|
52
|
+
},
|
|
53
|
+
messages: {
|
|
54
|
+
writeAllPermissions: "Avoid `write-all` in {{scope}}. Declare only the specific write scopes the workflow or job actually needs.",
|
|
55
|
+
},
|
|
56
|
+
schema: [],
|
|
57
|
+
type: "problem",
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
export default rule;
|
|
61
|
+
//# sourceMappingURL=no-write-all-permissions.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"no-write-all-permissions.js","sourceRoot":"","sources":["../../src/rules/no-write-all-permissions.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,8EAA8E;AAC9E,MAAM,0BAA0B,GAAG,CAC/B,eAAuC,EAChC,EAAE,CACT,oBAAoB,CAAC,eAAe,CAAC,KAAK,CAAC,EAAE,IAAI,EAAE,CAAC,WAAW,EAAE;IACjE,WAAW,CAAC;AAEhB,oEAAoE;AACpE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,cAAc,GAAG,CACnB,eAAuC,EACvC,KAAa,EACT,EAAE;YACN,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,KAAK;iBACR;gBACD,SAAS,EAAE,qBAAqB;gBAChC,IAAI,EAAE,eAAe,CAAC,KAA6B;aACtD,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,uBAAuB,GAAG,cAAc,CAC1C,IAAI,EACJ,aAAa,CAChB,CAAC;gBAEF,IACI,uBAAuB,KAAK,IAAI;oBAChC,0BAA0B,CAAC,uBAAuB,CAAC,EACrD,CAAC;oBACC,cAAc,CACV,uBAAuB,EACvB,kCAAkC,CACrC,CAAC;gBACN,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,kBAAkB,GAAG,cAAc,CACrC,GAAG,CAAC,OAAO,EACX,aAAa,CAChB,CAAC;oBAEF,IACI,kBAAkB,KAAK,IAAI;wBAC3B,0BAA0B,CAAC,kBAAkB,CAAC,EAChD,CAAC;wBACC,cAAc,CACV,kBAAkB,EAClB,QAAQ,GAAG,CAAC,EAAE,eAAe,CAChC,CAAC;oBACN,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,iCAAiC;gBACjC,+BAA+B;aAClC;YACD,WAAW,EACP,oGAAoG;YACxG,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,iGAAiG;SACzG;QACD,QAAQ,EAAE;YACN,mBAAmB,EACf,4GAA4G;SACnH;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require immutable full-length SHA pins for third-party actions and reusable workflows.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/**
|
|
7
|
+
* Rule implementation for requiring immutable SHA pins on external uses
|
|
8
|
+
* references.
|
|
9
|
+
*/
|
|
10
|
+
declare const rule: Rule.RuleModule;
|
|
11
|
+
export default rule;
|
|
12
|
+
//# sourceMappingURL=pin-action-shas.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pin-action-shas.d.ts","sourceRoot":"","sources":["../../src/rules/pin-action-shas.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAqCnC;;;GAGG;AACH,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAmHhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,100 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsSequence, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Full commit SHA pattern recommended by GitHub for pinning action refs. */
|
|
3
|
+
const FULL_SHA_PATTERN = /^[0-9a-f]{40}$/u;
|
|
4
|
+
/** Determine whether a `uses` reference is a local action path. */
|
|
5
|
+
const isLocalActionReference = (reference) => reference.startsWith("./");
|
|
6
|
+
/** Determine whether a `uses` reference is a Docker image reference. */
|
|
7
|
+
const isDockerReference = (reference) => reference.startsWith("docker://");
|
|
8
|
+
/** Determine whether a `uses` reference targets a reusable workflow. */
|
|
9
|
+
const isReusableWorkflowReference = (reference) => reference.includes("/.github/workflows/");
|
|
10
|
+
/** Extract the ref segment after the final `@` delimiter. */
|
|
11
|
+
const getReferenceRef = (reference) => {
|
|
12
|
+
const delimiterIndex = reference.lastIndexOf("@");
|
|
13
|
+
return delimiterIndex === -1 ? null : reference.slice(delimiterIndex + 1);
|
|
14
|
+
};
|
|
15
|
+
/** Determine whether a GitHub `uses` reference must be SHA pinned. */
|
|
16
|
+
const shouldValidateUsesReference = (reference) => !isLocalActionReference(reference) && !isDockerReference(reference);
|
|
17
|
+
/**
|
|
18
|
+
* Rule implementation for requiring immutable SHA pins on external uses
|
|
19
|
+
* references.
|
|
20
|
+
*/
|
|
21
|
+
const rule = {
|
|
22
|
+
create(context) {
|
|
23
|
+
const reportReference = (node, reference) => {
|
|
24
|
+
if (!shouldValidateUsesReference(reference)) {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
const ref = getReferenceRef(reference);
|
|
28
|
+
if (ref !== null && FULL_SHA_PATTERN.test(ref)) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
context.report({
|
|
32
|
+
data: {
|
|
33
|
+
ref: ref ?? "<missing ref>",
|
|
34
|
+
reference,
|
|
35
|
+
},
|
|
36
|
+
messageId: isReusableWorkflowReference(reference)
|
|
37
|
+
? "unpinnedReusableWorkflow"
|
|
38
|
+
: "unpinnedAction",
|
|
39
|
+
node: node,
|
|
40
|
+
});
|
|
41
|
+
};
|
|
42
|
+
return {
|
|
43
|
+
Program() {
|
|
44
|
+
const root = getWorkflowRoot(context);
|
|
45
|
+
if (root === null) {
|
|
46
|
+
return;
|
|
47
|
+
}
|
|
48
|
+
for (const job of getWorkflowJobs(root)) {
|
|
49
|
+
const reusableWorkflowPair = getMappingPair(job.mapping, "uses");
|
|
50
|
+
const reusableWorkflowReference = getScalarStringValue(reusableWorkflowPair?.value ?? null);
|
|
51
|
+
if (reusableWorkflowPair !== null &&
|
|
52
|
+
reusableWorkflowReference !== null) {
|
|
53
|
+
reportReference((reusableWorkflowPair.value ??
|
|
54
|
+
reusableWorkflowPair), reusableWorkflowReference);
|
|
55
|
+
}
|
|
56
|
+
const stepsSequence = getMappingValueAsSequence(job.mapping, "steps");
|
|
57
|
+
if (stepsSequence === null) {
|
|
58
|
+
continue;
|
|
59
|
+
}
|
|
60
|
+
for (const entry of stepsSequence.entries) {
|
|
61
|
+
const stepMapping = unwrapYamlValue(entry);
|
|
62
|
+
if (stepMapping?.type !== "YAMLMapping") {
|
|
63
|
+
continue;
|
|
64
|
+
}
|
|
65
|
+
const usesPair = getMappingPair(stepMapping, "uses");
|
|
66
|
+
const usesReference = getScalarStringValue(usesPair?.value ?? null);
|
|
67
|
+
if (usesPair === null || usesReference === null) {
|
|
68
|
+
continue;
|
|
69
|
+
}
|
|
70
|
+
reportReference((usesPair.value ??
|
|
71
|
+
usesPair), usesReference);
|
|
72
|
+
}
|
|
73
|
+
}
|
|
74
|
+
},
|
|
75
|
+
};
|
|
76
|
+
},
|
|
77
|
+
meta: {
|
|
78
|
+
docs: {
|
|
79
|
+
configs: [
|
|
80
|
+
"github-actions.configs.all",
|
|
81
|
+
"github-actions.configs.security",
|
|
82
|
+
"github-actions.configs.strict",
|
|
83
|
+
],
|
|
84
|
+
description: "require third-party `uses` references to pin full-length commit SHAs instead of mutable tags or branches.",
|
|
85
|
+
recommended: false,
|
|
86
|
+
requiresTypeChecking: false,
|
|
87
|
+
ruleId: "R003",
|
|
88
|
+
ruleNumber: 3,
|
|
89
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/pin-action-shas",
|
|
90
|
+
},
|
|
91
|
+
messages: {
|
|
92
|
+
unpinnedAction: "Action reference '{{reference}}' should pin a full 40-character commit SHA instead of '{{ref}}'.",
|
|
93
|
+
unpinnedReusableWorkflow: "Reusable workflow reference '{{reference}}' should pin a full 40-character commit SHA instead of '{{ref}}'.",
|
|
94
|
+
},
|
|
95
|
+
schema: [],
|
|
96
|
+
type: "suggestion",
|
|
97
|
+
},
|
|
98
|
+
};
|
|
99
|
+
export default rule;
|
|
100
|
+
//# sourceMappingURL=pin-action-shas.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"pin-action-shas.js","sourceRoot":"","sources":["../../src/rules/pin-action-shas.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,yBAAyB,EACzB,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,6EAA6E;AAC7E,MAAM,gBAAgB,GAAG,iBAAiB,CAAC;AAE3C,mEAAmE;AACnE,MAAM,sBAAsB,GAAG,CAAC,SAAiB,EAAW,EAAE,CAC1D,SAAS,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC;AAE/B,wEAAwE;AACxE,MAAM,iBAAiB,GAAG,CAAC,SAAiB,EAAW,EAAE,CACrD,SAAS,CAAC,UAAU,CAAC,WAAW,CAAC,CAAC;AAEtC,wEAAwE;AACxE,MAAM,2BAA2B,GAAG,CAAC,SAAiB,EAAW,EAAE,CAC/D,SAAS,CAAC,QAAQ,CAAC,qBAAqB,CAAC,CAAC;AAE9C,6DAA6D;AAC7D,MAAM,eAAe,GAAG,CAAC,SAAiB,EAAiB,EAAE;IACzD,MAAM,cAAc,GAAG,SAAS,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC;IAElD,OAAO,cAAc,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,SAAS,CAAC,KAAK,CAAC,cAAc,GAAG,CAAC,CAAC,CAAC;AAC9E,CAAC,CAAC;AAEF,sEAAsE;AACtE,MAAM,2BAA2B,GAAG,CAAC,SAAiB,EAAW,EAAE,CAC/D,CAAC,sBAAsB,CAAC,SAAS,CAAC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC,CAAC;AAExE;;;GAGG;AACH,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,eAAe,GAAG,CACpB,IAAsC,EACtC,SAAiB,EACb,EAAE;YACN,IAAI,CAAC,2BAA2B,CAAC,SAAS,CAAC,EAAE,CAAC;gBAC1C,OAAO;YACX,CAAC;YAED,MAAM,GAAG,GAAG,eAAe,CAAC,SAAS,CAAC,CAAC;YAEvC,IAAI,GAAG,KAAK,IAAI,IAAI,gBAAgB,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC;gBAC7C,OAAO;YACX,CAAC;YAED,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,GAAG,EAAE,GAAG,IAAI,eAAe;oBAC3B,SAAS;iBACZ;gBACD,SAAS,EAAE,2BAA2B,CAAC,SAAS,CAAC;oBAC7C,CAAC,CAAC,0BAA0B;oBAC5B,CAAC,CAAC,gBAAgB;gBACtB,IAAI,EAAE,IAAiB;aAC1B,CAAC,CAAC;QACP,CAAC,CAAC;QAEF,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,oBAAoB,GAAG,cAAc,CACvC,GAAG,CAAC,OAAO,EACX,MAAM,CACT,CAAC;oBACF,MAAM,yBAAyB,GAAG,oBAAoB,CAClD,oBAAoB,EAAE,KAAK,IAAI,IAAI,CACtC,CAAC;oBAEF,IACI,oBAAoB,KAAK,IAAI;wBAC7B,yBAAyB,KAAK,IAAI,EACpC,CAAC;wBACC,eAAe,CACX,CAAC,oBAAoB,CAAC,KAAK;4BACvB,oBAAoB,CAAyB,EACjD,yBAAyB,CAC5B,CAAC;oBACN,CAAC;oBAED,MAAM,aAAa,GAAG,yBAAyB,CAC3C,GAAG,CAAC,OAAO,EACX,OAAO,CACV,CAAC;oBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;wBACzB,SAAS;oBACb,CAAC;oBAED,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;wBACxC,MAAM,WAAW,GAAG,eAAe,CAAC,KAAK,CAAC,CAAC;wBAE3C,IAAI,WAAW,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;4BACtC,SAAS;wBACb,CAAC;wBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,WAAW,EAAE,MAAM,CAAC,CAAC;wBACrD,MAAM,aAAa,GAAG,oBAAoB,CACtC,QAAQ,EAAE,KAAK,IAAI,IAAI,CAC1B,CAAC;wBAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;4BAC9C,SAAS;wBACb,CAAC;wBAED,eAAe,CACX,CAAC,QAAQ,CAAC,KAAK;4BACX,QAAQ,CAAyB,EACrC,aAAa,CAChB,CAAC;oBACN,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,iCAAiC;gBACjC,+BAA+B;aAClC;YACD,WAAW,EACP,2GAA2G;YAC/G,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,CAAC;YACb,GAAG,EAAE,wFAAwF;SAChG;QACD,QAAQ,EAAE;YACN,cAAc,EACV,kGAAkG;YACtG,wBAAwB,EACpB,6GAA6G;SACpH;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Prefer `action.yml` over `action.yaml` for action metadata.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for preferring `action.yml`. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-action-yml.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-action-yml.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-action-yml.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAEnC,uDAAuD;AACvD,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoChB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,37 @@
|
|
|
1
|
+
/** Rule implementation for preferring `action.yml`. */
|
|
2
|
+
const rule = {
|
|
3
|
+
create(context) {
|
|
4
|
+
return {
|
|
5
|
+
Program(node) {
|
|
6
|
+
if (!context.filename.toLowerCase().endsWith("action.yaml")) {
|
|
7
|
+
return;
|
|
8
|
+
}
|
|
9
|
+
context.report({
|
|
10
|
+
messageId: "preferActionYml",
|
|
11
|
+
node: node,
|
|
12
|
+
});
|
|
13
|
+
},
|
|
14
|
+
};
|
|
15
|
+
},
|
|
16
|
+
meta: {
|
|
17
|
+
docs: {
|
|
18
|
+
configs: [
|
|
19
|
+
"github-actions.configs.actionMetadata",
|
|
20
|
+
"github-actions.configs.all",
|
|
21
|
+
],
|
|
22
|
+
description: "require action metadata files to prefer `action.yml` over `action.yaml`.",
|
|
23
|
+
recommended: true,
|
|
24
|
+
requiresTypeChecking: false,
|
|
25
|
+
ruleId: "R043",
|
|
26
|
+
ruleNumber: 43,
|
|
27
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-action-yml",
|
|
28
|
+
},
|
|
29
|
+
messages: {
|
|
30
|
+
preferActionYml: "Prefer naming action metadata files `action.yml` instead of `action.yaml`.",
|
|
31
|
+
},
|
|
32
|
+
schema: [],
|
|
33
|
+
type: "suggestion",
|
|
34
|
+
},
|
|
35
|
+
};
|
|
36
|
+
export default rule;
|
|
37
|
+
//# sourceMappingURL=prefer-action-yml.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-action-yml.js","sourceRoot":"","sources":["../../src/rules/prefer-action-yml.ts"],"names":[],"mappings":"AAMA,uDAAuD;AACvD,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,QAAQ,CAAC,aAAa,CAAC,EAAE,CAAC;oBAC1D,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,SAAS,EAAE,iBAAiB;oBAC5B,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,uCAAuC;gBACvC,4BAA4B;aAC/B;YACD,WAAW,EACP,0EAA0E;YAC9E,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,0FAA0F;SAClG;QACD,QAAQ,EAAE;YACN,eAAe,EACX,4EAA4E;SACnF;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Prefer matrix fail-fast behavior over explicitly disabling it.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for discouraging `strategy.fail-fast: false`. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-fail-fast.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-fail-fast.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-fail-fast.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAWnC,wEAAwE;AACxE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+EhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { getMappingPair, getScalarStringValue, getWorkflowJobs, getWorkflowRoot, isGithubExpressionScalar, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Rule implementation for discouraging `strategy.fail-fast: false`. */
|
|
3
|
+
const rule = {
|
|
4
|
+
create(context) {
|
|
5
|
+
return {
|
|
6
|
+
Program() {
|
|
7
|
+
const root = getWorkflowRoot(context);
|
|
8
|
+
if (root === null) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
for (const job of getWorkflowJobs(root)) {
|
|
12
|
+
const strategyPair = getMappingPair(job.mapping, "strategy");
|
|
13
|
+
const strategyValue = unwrapYamlValue(strategyPair?.value ?? null);
|
|
14
|
+
if (strategyValue?.type !== "YAMLMapping") {
|
|
15
|
+
continue;
|
|
16
|
+
}
|
|
17
|
+
const failFastPair = getMappingPair(strategyValue, "fail-fast");
|
|
18
|
+
if (failFastPair === null ||
|
|
19
|
+
isGithubExpressionScalar(failFastPair.value)) {
|
|
20
|
+
continue;
|
|
21
|
+
}
|
|
22
|
+
const failFastValue = unwrapYamlValue(failFastPair.value);
|
|
23
|
+
const failFastText = getScalarStringValue(failFastPair.value);
|
|
24
|
+
if (failFastValue?.type === "YAMLScalar" &&
|
|
25
|
+
(failFastValue.value === false ||
|
|
26
|
+
failFastText === "false")) {
|
|
27
|
+
context.report({
|
|
28
|
+
data: {
|
|
29
|
+
jobId: job.id,
|
|
30
|
+
},
|
|
31
|
+
messageId: "failFastDisabled",
|
|
32
|
+
node: (failFastPair.value ??
|
|
33
|
+
failFastPair),
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
},
|
|
38
|
+
};
|
|
39
|
+
},
|
|
40
|
+
meta: {
|
|
41
|
+
docs: {
|
|
42
|
+
configs: [
|
|
43
|
+
"github-actions.configs.all",
|
|
44
|
+
"github-actions.configs.strict",
|
|
45
|
+
],
|
|
46
|
+
description: "disallow `strategy.fail-fast: false` so failing matrix jobs can stop redundant work sooner.",
|
|
47
|
+
recommended: false,
|
|
48
|
+
requiresTypeChecking: false,
|
|
49
|
+
ruleId: "R015",
|
|
50
|
+
ruleNumber: 15,
|
|
51
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-fail-fast",
|
|
52
|
+
},
|
|
53
|
+
messages: {
|
|
54
|
+
failFastDisabled: "Job '{{jobId}}' disables `strategy.fail-fast`. Prefer `true` or a GitHub expression instead.",
|
|
55
|
+
},
|
|
56
|
+
schema: [],
|
|
57
|
+
type: "suggestion",
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
export default rule;
|
|
61
|
+
//# sourceMappingURL=prefer-fail-fast.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-fail-fast.js","sourceRoot":"","sources":["../../src/rules/prefer-fail-fast.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,EACf,eAAe,EACf,wBAAwB,EACxB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,wEAAwE;AACxE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,GAAG,IAAI,eAAe,CAAC,IAAI,CAAC,EAAE,CAAC;oBACtC,MAAM,YAAY,GAAG,cAAc,CAC/B,GAAG,CAAC,OAAO,EACX,UAAU,CACb,CAAC;oBACF,MAAM,aAAa,GAAG,eAAe,CACjC,YAAY,EAAE,KAAK,IAAI,IAAI,CAC9B,CAAC;oBAEF,IAAI,aAAa,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;wBACxC,SAAS;oBACb,CAAC;oBAED,MAAM,YAAY,GAAG,cAAc,CAC/B,aAAa,EACb,WAAW,CACd,CAAC;oBAEF,IACI,YAAY,KAAK,IAAI;wBACrB,wBAAwB,CAAC,YAAY,CAAC,KAAK,CAAC,EAC9C,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,MAAM,aAAa,GAAG,eAAe,CAAC,YAAY,CAAC,KAAK,CAAC,CAAC;oBAC1D,MAAM,YAAY,GAAG,oBAAoB,CACrC,YAAY,CAAC,KAAK,CACrB,CAAC;oBAEF,IACI,aAAa,EAAE,IAAI,KAAK,YAAY;wBACpC,CAAC,aAAa,CAAC,KAAK,KAAK,KAAK;4BAC1B,YAAY,KAAK,OAAO,CAAC,EAC/B,CAAC;wBACC,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,KAAK,EAAE,GAAG,CAAC,EAAE;6BAChB;4BACD,SAAS,EAAE,kBAAkB;4BAC7B,IAAI,EAAE,CAAC,YAAY,CAAC,KAAK;gCACrB,YAAY,CAAyB;yBAC5C,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,+BAA+B;aAClC;YACD,WAAW,EACP,6FAA6F;YACjG,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,yFAAyF;SACjG;QACD,QAAQ,EAAE;YACN,gBAAgB,EACZ,8FAA8F;SACrG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Enforce a consistent file extension for workflow files.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for enforcing workflow file extensions. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-file-extension.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-file-extension.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-file-extension.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA8CnC,kEAAkE;AAClE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA+FhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,104 @@
|
|
|
1
|
+
import { extname } from "node:path";
|
|
2
|
+
/** Supported workflow filename extensions. */
|
|
3
|
+
const workflowFileExtensions = ["yaml", "yml"];
|
|
4
|
+
/** Default workflow file extension. */
|
|
5
|
+
const DEFAULT_WORKFLOW_FILE_EXTENSION = "yml";
|
|
6
|
+
/** Normalize file extension options into a consistent runtime shape. */
|
|
7
|
+
const normalizePreferFileExtensionOptions = (option) => {
|
|
8
|
+
if (option === undefined || typeof option === "string") {
|
|
9
|
+
return {
|
|
10
|
+
caseSensitive: true,
|
|
11
|
+
extension: option ?? DEFAULT_WORKFLOW_FILE_EXTENSION,
|
|
12
|
+
};
|
|
13
|
+
}
|
|
14
|
+
return {
|
|
15
|
+
caseSensitive: option.caseSensitive ?? true,
|
|
16
|
+
extension: option.extension ?? DEFAULT_WORKFLOW_FILE_EXTENSION,
|
|
17
|
+
};
|
|
18
|
+
};
|
|
19
|
+
/** Rule implementation for enforcing workflow file extensions. */
|
|
20
|
+
const rule = {
|
|
21
|
+
create(context) {
|
|
22
|
+
const [option] = context.options;
|
|
23
|
+
const { caseSensitive, extension } = normalizePreferFileExtensionOptions(option ?? undefined);
|
|
24
|
+
return {
|
|
25
|
+
Program(node) {
|
|
26
|
+
const actualExtensionWithDot = extname(context.filename);
|
|
27
|
+
if (actualExtensionWithDot.length === 0) {
|
|
28
|
+
return;
|
|
29
|
+
}
|
|
30
|
+
const actualExtension = actualExtensionWithDot.slice(1);
|
|
31
|
+
if (actualExtension === undefined) {
|
|
32
|
+
return;
|
|
33
|
+
}
|
|
34
|
+
const normalizedActualExtension = caseSensitive
|
|
35
|
+
? actualExtension
|
|
36
|
+
: actualExtension.toLowerCase();
|
|
37
|
+
const normalizedExpectedExtension = caseSensitive
|
|
38
|
+
? extension
|
|
39
|
+
: extension.toLowerCase();
|
|
40
|
+
if (normalizedActualExtension === normalizedExpectedExtension) {
|
|
41
|
+
return;
|
|
42
|
+
}
|
|
43
|
+
context.report({
|
|
44
|
+
data: {
|
|
45
|
+
actual: `.${actualExtension}`,
|
|
46
|
+
expected: `.${extension}`,
|
|
47
|
+
},
|
|
48
|
+
messageId: "unexpectedExtension",
|
|
49
|
+
node: node,
|
|
50
|
+
});
|
|
51
|
+
},
|
|
52
|
+
};
|
|
53
|
+
},
|
|
54
|
+
meta: {
|
|
55
|
+
defaultOptions: [DEFAULT_WORKFLOW_FILE_EXTENSION],
|
|
56
|
+
docs: {
|
|
57
|
+
configs: [
|
|
58
|
+
"github-actions.configs.all",
|
|
59
|
+
"github-actions.configs.recommended",
|
|
60
|
+
"github-actions.configs.strict",
|
|
61
|
+
],
|
|
62
|
+
description: "enforce a consistent file extension for GitHub Actions workflow files.",
|
|
63
|
+
recommended: true,
|
|
64
|
+
requiresTypeChecking: false,
|
|
65
|
+
ruleId: "R020",
|
|
66
|
+
ruleNumber: 20,
|
|
67
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-file-extension",
|
|
68
|
+
},
|
|
69
|
+
messages: {
|
|
70
|
+
unexpectedExtension: "Expected workflow files to use the {{expected}} extension, but found {{actual}}.",
|
|
71
|
+
},
|
|
72
|
+
schema: [
|
|
73
|
+
{
|
|
74
|
+
anyOf: [
|
|
75
|
+
{
|
|
76
|
+
description: "Expected workflow filename extension.",
|
|
77
|
+
enum: workflowFileExtensions,
|
|
78
|
+
type: "string",
|
|
79
|
+
},
|
|
80
|
+
{
|
|
81
|
+
additionalProperties: false,
|
|
82
|
+
description: "Workflow filename extension options.",
|
|
83
|
+
properties: {
|
|
84
|
+
caseSensitive: {
|
|
85
|
+
description: "Whether extension matching should preserve case.",
|
|
86
|
+
type: "boolean",
|
|
87
|
+
},
|
|
88
|
+
extension: {
|
|
89
|
+
description: "Expected workflow filename extension.",
|
|
90
|
+
enum: workflowFileExtensions,
|
|
91
|
+
type: "string",
|
|
92
|
+
},
|
|
93
|
+
},
|
|
94
|
+
type: "object",
|
|
95
|
+
},
|
|
96
|
+
],
|
|
97
|
+
description: "Workflow filename extension preference, either as a simple extension string or an option object.",
|
|
98
|
+
},
|
|
99
|
+
],
|
|
100
|
+
type: "suggestion",
|
|
101
|
+
},
|
|
102
|
+
};
|
|
103
|
+
export default rule;
|
|
104
|
+
//# sourceMappingURL=prefer-file-extension.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-file-extension.js","sourceRoot":"","sources":["../../src/rules/prefer-file-extension.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,OAAO,EAAE,MAAM,WAAW,CAAC;AAEpC,8CAA8C;AAC9C,MAAM,sBAAsB,GAAG,CAAC,MAAM,EAAE,KAAK,CAAU,CAAC;AAgBxD,uCAAuC;AACvC,MAAM,+BAA+B,GAA0B,KAAK,CAAC;AAErE,wEAAwE;AACxE,MAAM,mCAAmC,GAAG,CACxC,MAEC,EAIH,EAAE;IACA,IAAI,MAAM,KAAK,SAAS,IAAI,OAAO,MAAM,KAAK,QAAQ,EAAE,CAAC;QACrD,OAAO;YACH,aAAa,EAAE,IAAI;YACnB,SAAS,EAAE,MAAM,IAAI,+BAA+B;SACvD,CAAC;IACN,CAAC;IAED,OAAO;QACH,aAAa,EAAE,MAAM,CAAC,aAAa,IAAI,IAAI;QAC3C,SAAS,EAAE,MAAM,CAAC,SAAS,IAAI,+BAA+B;KACjE,CAAC;AACN,CAAC,CAAC;AAEF,kEAAkE;AAClE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,CAAC,MAAM,CAAC,GAAG,OAAO,CAAC,OAAuC,CAAC;QACjE,MAAM,EAAE,aAAa,EAAE,SAAS,EAAE,GAC9B,mCAAmC,CAAC,MAAM,IAAI,SAAS,CAAC,CAAC;QAE7D,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,MAAM,sBAAsB,GAAG,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;gBAEzD,IAAI,sBAAsB,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACtC,OAAO;gBACX,CAAC;gBAED,MAAM,eAAe,GAAG,sBAAsB,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;gBAExD,IAAI,eAAe,KAAK,SAAS,EAAE,CAAC;oBAChC,OAAO;gBACX,CAAC;gBAED,MAAM,yBAAyB,GAAG,aAAa;oBAC3C,CAAC,CAAC,eAAe;oBACjB,CAAC,CAAC,eAAe,CAAC,WAAW,EAAE,CAAC;gBACpC,MAAM,2BAA2B,GAAG,aAAa;oBAC7C,CAAC,CAAC,SAAS;oBACX,CAAC,CAAC,SAAS,CAAC,WAAW,EAAE,CAAC;gBAE9B,IAAI,yBAAyB,KAAK,2BAA2B,EAAE,CAAC;oBAC5D,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,MAAM,EAAE,IAAI,eAAe,EAAE;wBAC7B,QAAQ,EAAE,IAAI,SAAS,EAAE;qBAC5B;oBACD,SAAS,EAAE,qBAAqB;oBAChC,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,cAAc,EAAE,CAAC,+BAA+B,CAAC;QACjD,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,wEAAwE;YAC5E,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,8FAA8F;SACtG;QACD,QAAQ,EAAE;YACN,mBAAmB,EACf,kFAAkF;SACzF;QACD,MAAM,EAAE;YACJ;gBACI,KAAK,EAAE;oBACH;wBACI,WAAW,EAAE,uCAAuC;wBACpD,IAAI,EAAE,sBAAsB;wBAC5B,IAAI,EAAE,QAAQ;qBACjB;oBACD;wBACI,oBAAoB,EAAE,KAAK;wBAC3B,WAAW,EAAE,sCAAsC;wBACnD,UAAU,EAAE;4BACR,aAAa,EAAE;gCACX,WAAW,EACP,kDAAkD;gCACtD,IAAI,EAAE,SAAS;6BAClB;4BACD,SAAS,EAAE;gCACP,WAAW,EACP,uCAAuC;gCAC3C,IAAI,EAAE,sBAAsB;gCAC5B,IAAI,EAAE,QAAQ;6BACjB;yBACJ;wBACD,IAAI,EAAE,QAAQ;qBACjB;iBACJ;gBACD,WAAW,EACP,kGAAkG;aACzG;SACJ;QACD,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Prefer the `inputs` context over `github.event.inputs` in manual workflows.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for preferring the `inputs` context. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-inputs-context.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-inputs-context.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-inputs-context.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAgEnC,+DAA+D;AAC/D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAkEhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,91 @@
|
|
|
1
|
+
import { getScalarStringValue, getWorkflowEventNames, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Legacy workflow_dispatch inputs context prefix. */
|
|
3
|
+
const githubEventInputsPrefix = "github.event.inputs.";
|
|
4
|
+
/** Preferred workflow_dispatch inputs context prefix. */
|
|
5
|
+
const inputsContextPrefix = "inputs.";
|
|
6
|
+
/** Check whether a scalar string references the legacy inputs context. */
|
|
7
|
+
const hasGithubEventInputsReference = (value) => value.includes(githubEventInputsPrefix);
|
|
8
|
+
/** Replace legacy workflow_dispatch inputs references with the preferred form. */
|
|
9
|
+
const replaceGithubEventInputsReferences = (value) => value.replaceAll(githubEventInputsPrefix, inputsContextPrefix);
|
|
10
|
+
/** Visit every string scalar reachable from a YAML value node. */
|
|
11
|
+
const visitStringScalars = (node, visitor) => {
|
|
12
|
+
const unwrappedNode = unwrapYamlValue(node);
|
|
13
|
+
if (unwrappedNode === null) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
if (unwrappedNode.type === "YAMLScalar") {
|
|
17
|
+
const value = getScalarStringValue(unwrappedNode);
|
|
18
|
+
if (value !== null) {
|
|
19
|
+
visitor(unwrappedNode, value);
|
|
20
|
+
}
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
if (unwrappedNode.type === "YAMLSequence") {
|
|
24
|
+
for (const entry of unwrappedNode.entries) {
|
|
25
|
+
visitStringScalars(entry, visitor);
|
|
26
|
+
}
|
|
27
|
+
return;
|
|
28
|
+
}
|
|
29
|
+
if (unwrappedNode.type !== "YAMLMapping") {
|
|
30
|
+
return;
|
|
31
|
+
}
|
|
32
|
+
for (const pair of unwrappedNode.pairs) {
|
|
33
|
+
visitStringScalars(pair.value ?? null, visitor);
|
|
34
|
+
}
|
|
35
|
+
};
|
|
36
|
+
/** Rule implementation for preferring the `inputs` context. */
|
|
37
|
+
const rule = {
|
|
38
|
+
create(context) {
|
|
39
|
+
return {
|
|
40
|
+
Program() {
|
|
41
|
+
const root = getWorkflowRoot(context);
|
|
42
|
+
if (root === null) {
|
|
43
|
+
return;
|
|
44
|
+
}
|
|
45
|
+
const eventNames = getWorkflowEventNames(root);
|
|
46
|
+
if (!eventNames.has("workflow_dispatch")) {
|
|
47
|
+
return;
|
|
48
|
+
}
|
|
49
|
+
visitStringScalars(root, (node, value) => {
|
|
50
|
+
if (!hasGithubEventInputsReference(value)) {
|
|
51
|
+
return;
|
|
52
|
+
}
|
|
53
|
+
context.report({
|
|
54
|
+
fix: (fixer) => {
|
|
55
|
+
const originalText = context.sourceCode.text.slice(node.range[0], node.range[1]);
|
|
56
|
+
const fixedText = replaceGithubEventInputsReferences(originalText);
|
|
57
|
+
return originalText === fixedText
|
|
58
|
+
? null
|
|
59
|
+
: fixer.replaceTextRange(node.range, fixedText);
|
|
60
|
+
},
|
|
61
|
+
messageId: "preferInputsContext",
|
|
62
|
+
node: node,
|
|
63
|
+
});
|
|
64
|
+
});
|
|
65
|
+
},
|
|
66
|
+
};
|
|
67
|
+
},
|
|
68
|
+
meta: {
|
|
69
|
+
docs: {
|
|
70
|
+
configs: [
|
|
71
|
+
"github-actions.configs.all",
|
|
72
|
+
"github-actions.configs.recommended",
|
|
73
|
+
"github-actions.configs.strict",
|
|
74
|
+
],
|
|
75
|
+
description: "enforce the `inputs` context instead of `github.event.inputs` in `workflow_dispatch` workflows so boolean inputs preserve their native type semantics.",
|
|
76
|
+
recommended: true,
|
|
77
|
+
requiresTypeChecking: false,
|
|
78
|
+
ruleId: "R033",
|
|
79
|
+
ruleNumber: 33,
|
|
80
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/prefer-inputs-context",
|
|
81
|
+
},
|
|
82
|
+
fixable: "code",
|
|
83
|
+
messages: {
|
|
84
|
+
preferInputsContext: "Prefer `inputs.*` over `github.event.inputs.*` in `workflow_dispatch` workflows because the `inputs` context preserves booleans and is the documented shorthand.",
|
|
85
|
+
},
|
|
86
|
+
schema: [],
|
|
87
|
+
type: "suggestion",
|
|
88
|
+
},
|
|
89
|
+
};
|
|
90
|
+
export default rule;
|
|
91
|
+
//# sourceMappingURL=prefer-inputs-context.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-inputs-context.js","sourceRoot":"","sources":["../../src/rules/prefer-inputs-context.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,oBAAoB,EACpB,qBAAqB,EACrB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,sDAAsD;AACtD,MAAM,uBAAuB,GAAG,sBAAsB,CAAC;AAEvD,yDAAyD;AACzD,MAAM,mBAAmB,GAAG,SAAS,CAAC;AAEtC,0EAA0E;AAC1E,MAAM,6BAA6B,GAAG,CAAC,KAAa,EAAW,EAAE,CAC7D,KAAK,CAAC,QAAQ,CAAC,uBAAuB,CAAC,CAAC;AAE5C,kFAAkF;AAClF,MAAM,kCAAkC,GAAG,CAAC,KAAa,EAAU,EAAE,CACjE,KAAK,CAAC,UAAU,CAAC,uBAAuB,EAAE,mBAAmB,CAAC,CAAC;AAEnE,kEAAkE;AAClE,MAAM,kBAAkB,GAAG,CACvB,IAAyD,EACzD,OAAgE,EAC5D,EAAE;IACN,MAAM,aAAa,GAAG,eAAe,CACjC,IAAiD,CACpD,CAAC;IAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;QACzB,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QACtC,MAAM,KAAK,GAAG,oBAAoB,CAAC,aAAa,CAAC,CAAC;QAElD,IAAI,KAAK,KAAK,IAAI,EAAE,CAAC;YACjB,OAAO,CAAC,aAAa,EAAE,KAAK,CAAC,CAAC;QAClC,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACxC,KAAK,MAAM,KAAK,IAAI,aAAa,CAAC,OAAO,EAAE,CAAC;YACxC,kBAAkB,CAAC,KAAK,EAAE,OAAO,CAAC,CAAC;QACvC,CAAC;QAED,OAAO;IACX,CAAC;IAED,IAAI,aAAa,CAAC,IAAI,KAAK,aAAa,EAAE,CAAC;QACvC,OAAO;IACX,CAAC;IAED,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;QACrC,kBAAkB,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,EAAE,OAAO,CAAC,CAAC;IACpD,CAAC;AACL,CAAC,CAAC;AAEF,+DAA+D;AAC/D,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO;gBACH,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,UAAU,GAAG,qBAAqB,CAAC,IAAI,CAAC,CAAC;gBAE/C,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,mBAAmB,CAAC,EAAE,CAAC;oBACvC,OAAO;gBACX,CAAC;gBAED,kBAAkB,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE;oBACrC,IAAI,CAAC,6BAA6B,CAAC,KAAK,CAAC,EAAE,CAAC;wBACxC,OAAO;oBACX,CAAC;oBAED,OAAO,CAAC,MAAM,CAAC;wBACX,GAAG,EAAE,CAAC,KAAK,EAAE,EAAE;4BACX,MAAM,YAAY,GAAG,OAAO,CAAC,UAAU,CAAC,IAAI,CAAC,KAAK,CAC9C,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,EACb,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,CAChB,CAAC;4BACF,MAAM,SAAS,GACX,kCAAkC,CAC9B,YAAY,CACf,CAAC;4BAEN,OAAO,YAAY,KAAK,SAAS;gCAC7B,CAAC,CAAC,IAAI;gCACN,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,IAAI,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;wBACxD,CAAC;wBACD,SAAS,EAAE,qBAAqB;wBAChC,IAAI,EAAE,IAA4B;qBACrC,CAAC,CAAC;gBACP,CAAC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,4BAA4B;gBAC5B,oCAAoC;gBACpC,+BAA+B;aAClC;YACD,WAAW,EACP,wJAAwJ;YAC5J,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,8FAA8F;SACtG;QACD,OAAO,EAAE,MAAM;QACf,QAAQ,EAAE;YACN,mBAAmB,EACf,kKAAkK;SACzK;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Enforce a consistent style for step-level `uses:` references.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for enforcing step-level `uses:` reference style. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=prefer-step-uses-style.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"prefer-step-uses-style.d.ts","sourceRoot":"","sources":["../../src/rules/prefer-step-uses-style.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAgInC,4EAA4E;AAC5E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA0KhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|