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 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-categories.d.ts","sourceRoot":"","sources":["../../src/rules/require-template-categories.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AASnC,6DAA6D;AAC7D,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8DhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { isWorkflowTemplatePropertiesFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getWorkflowTemplatePropertiesRoot, getWorkflowTemplateStringProperty, } from "../_internal/workflow-template-properties.js";
|
|
3
|
+
import { getMappingValueAsSequence } from "../_internal/workflow-yaml.js";
|
|
4
|
+
/** Rule implementation for requiring template categories. */
|
|
5
|
+
const rule = {
|
|
6
|
+
create(context) {
|
|
7
|
+
return {
|
|
8
|
+
Program(node) {
|
|
9
|
+
if (!isWorkflowTemplatePropertiesFile(context.filename)) {
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
const root = getWorkflowTemplatePropertiesRoot(context);
|
|
13
|
+
if (root === null) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
const categoriesSequence = getMappingValueAsSequence(root, "categories");
|
|
17
|
+
if (categoriesSequence !== null &&
|
|
18
|
+
categoriesSequence.entries.length > 0) {
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
21
|
+
const templateName = getWorkflowTemplateStringProperty(root, "name") ??
|
|
22
|
+
"<unnamed-template>";
|
|
23
|
+
context.report({
|
|
24
|
+
data: {
|
|
25
|
+
templateName,
|
|
26
|
+
},
|
|
27
|
+
messageId: "missingCategories",
|
|
28
|
+
node: node,
|
|
29
|
+
});
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
meta: {
|
|
34
|
+
docs: {
|
|
35
|
+
configs: [
|
|
36
|
+
"github-actions.configs.workflowTemplateProperties",
|
|
37
|
+
"github-actions.configs.workflowTemplates",
|
|
38
|
+
"github-actions.configs.all",
|
|
39
|
+
],
|
|
40
|
+
description: "require non-empty `categories` in workflow-template metadata.",
|
|
41
|
+
recommended: true,
|
|
42
|
+
requiresTypeChecking: false,
|
|
43
|
+
ruleId: "R057",
|
|
44
|
+
ruleNumber: 57,
|
|
45
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-template-categories",
|
|
46
|
+
},
|
|
47
|
+
messages: {
|
|
48
|
+
missingCategories: "Workflow template '{{templateName}}' should declare at least one category in `categories`.",
|
|
49
|
+
},
|
|
50
|
+
schema: [],
|
|
51
|
+
type: "suggestion",
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
export default rule;
|
|
55
|
+
//# sourceMappingURL=require-template-categories.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-categories.js","sourceRoot":"","sources":["../../src/rules/require-template-categories.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EACH,iCAAiC,EACjC,iCAAiC,GACpC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,6DAA6D;AAC7D,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;gBAExD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,kBAAkB,GAAG,yBAAyB,CAChD,IAAI,EACJ,YAAY,CACf,CAAC;gBAEF,IACI,kBAAkB,KAAK,IAAI;oBAC3B,kBAAkB,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EACvC,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GACd,iCAAiC,CAAC,IAAI,EAAE,MAAM,CAAC;oBAC/C,oBAAoB,CAAC;gBAEzB,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,YAAY;qBACf;oBACD,SAAS,EAAE,mBAAmB;oBAC9B,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,mDAAmD;gBACnD,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,+DAA+D;YACnE,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,oGAAoG;SAC5G;QACD,QAAQ,EAAE;YACN,iBAAiB,EACb,4FAA4F;SACnG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require `filePatterns` in workflow-template properties metadata.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring non-empty template file patterns. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-template-file-patterns.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-file-patterns.d.ts","sourceRoot":"","sources":["../../src/rules/require-template-file-patterns.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AASnC,0EAA0E;AAC1E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UA8DhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,55 @@
|
|
|
1
|
+
import { isWorkflowTemplatePropertiesFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getWorkflowTemplatePropertiesRoot, getWorkflowTemplateStringProperty, } from "../_internal/workflow-template-properties.js";
|
|
3
|
+
import { getMappingValueAsSequence } from "../_internal/workflow-yaml.js";
|
|
4
|
+
/** Rule implementation for requiring non-empty template file patterns. */
|
|
5
|
+
const rule = {
|
|
6
|
+
create(context) {
|
|
7
|
+
return {
|
|
8
|
+
Program(node) {
|
|
9
|
+
if (!isWorkflowTemplatePropertiesFile(context.filename)) {
|
|
10
|
+
return;
|
|
11
|
+
}
|
|
12
|
+
const root = getWorkflowTemplatePropertiesRoot(context);
|
|
13
|
+
if (root === null) {
|
|
14
|
+
return;
|
|
15
|
+
}
|
|
16
|
+
const filePatternsSequence = getMappingValueAsSequence(root, "filePatterns");
|
|
17
|
+
if (filePatternsSequence !== null &&
|
|
18
|
+
filePatternsSequence.entries.length > 0) {
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
21
|
+
const templateName = getWorkflowTemplateStringProperty(root, "name") ??
|
|
22
|
+
"<unnamed-template>";
|
|
23
|
+
context.report({
|
|
24
|
+
data: {
|
|
25
|
+
templateName,
|
|
26
|
+
},
|
|
27
|
+
messageId: "missingFilePatterns",
|
|
28
|
+
node: node,
|
|
29
|
+
});
|
|
30
|
+
},
|
|
31
|
+
};
|
|
32
|
+
},
|
|
33
|
+
meta: {
|
|
34
|
+
docs: {
|
|
35
|
+
configs: [
|
|
36
|
+
"github-actions.configs.workflowTemplateProperties",
|
|
37
|
+
"github-actions.configs.workflowTemplates",
|
|
38
|
+
"github-actions.configs.all",
|
|
39
|
+
],
|
|
40
|
+
description: "require non-empty `filePatterns` in workflow-template metadata.",
|
|
41
|
+
recommended: true,
|
|
42
|
+
requiresTypeChecking: false,
|
|
43
|
+
ruleId: "R058",
|
|
44
|
+
ruleNumber: 58,
|
|
45
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-template-file-patterns",
|
|
46
|
+
},
|
|
47
|
+
messages: {
|
|
48
|
+
missingFilePatterns: "Workflow template '{{templateName}}' should declare `filePatterns` to improve chooser relevance.",
|
|
49
|
+
},
|
|
50
|
+
schema: [],
|
|
51
|
+
type: "suggestion",
|
|
52
|
+
},
|
|
53
|
+
};
|
|
54
|
+
export default rule;
|
|
55
|
+
//# sourceMappingURL=require-template-file-patterns.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-file-patterns.js","sourceRoot":"","sources":["../../src/rules/require-template-file-patterns.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EACH,iCAAiC,EACjC,iCAAiC,GACpC,MAAM,8CAA8C,CAAC;AACtD,OAAO,EAAE,yBAAyB,EAAE,MAAM,+BAA+B,CAAC;AAE1E,0EAA0E;AAC1E,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;gBAExD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,oBAAoB,GAAG,yBAAyB,CAClD,IAAI,EACJ,cAAc,CACjB,CAAC;gBAEF,IACI,oBAAoB,KAAK,IAAI;oBAC7B,oBAAoB,CAAC,OAAO,CAAC,MAAM,GAAG,CAAC,EACzC,CAAC;oBACC,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GACd,iCAAiC,CAAC,IAAI,EAAE,MAAM,CAAC;oBAC/C,oBAAoB,CAAC;gBAEzB,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,YAAY;qBACf;oBACD,SAAS,EAAE,qBAAqB;oBAChC,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,mDAAmD;gBACnD,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,iEAAiE;YACrE,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,uGAAuG;SAC/G;QACD,QAAQ,EAAE;YACN,mBAAmB,EACf,kGAAkG;SACzG;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require local workflow-template icon files referenced by `iconName` to exist.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for template icon file existence checks. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-template-icon-file-exists.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-icon-file-exists.d.ts","sourceRoot":"","sources":["../../src/rules/require-template-icon-file-exists.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAWnC,mEAAmE;AACnE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAqEhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,61 @@
|
|
|
1
|
+
import { existsSync } from "node:fs";
|
|
2
|
+
import { dirname, join } from "node:path";
|
|
3
|
+
import { isWorkflowTemplatePropertiesFile } from "../_internal/lint-targets.js";
|
|
4
|
+
import { getWorkflowTemplatePropertiesRoot, getWorkflowTemplateStringProperty, } from "../_internal/workflow-template-properties.js";
|
|
5
|
+
/** Rule implementation for template icon file existence checks. */
|
|
6
|
+
const rule = {
|
|
7
|
+
create(context) {
|
|
8
|
+
return {
|
|
9
|
+
Program(node) {
|
|
10
|
+
if (!isWorkflowTemplatePropertiesFile(context.filename)) {
|
|
11
|
+
return;
|
|
12
|
+
}
|
|
13
|
+
const root = getWorkflowTemplatePropertiesRoot(context);
|
|
14
|
+
if (root === null) {
|
|
15
|
+
return;
|
|
16
|
+
}
|
|
17
|
+
const iconName = getWorkflowTemplateStringProperty(root, "iconName");
|
|
18
|
+
if (iconName === null || iconName.trim().length === 0) {
|
|
19
|
+
return;
|
|
20
|
+
}
|
|
21
|
+
if (iconName.startsWith("octicon ")) {
|
|
22
|
+
return;
|
|
23
|
+
}
|
|
24
|
+
const iconFilePath = join(dirname(context.filename), `${iconName}.svg`);
|
|
25
|
+
if (existsSync(iconFilePath)) {
|
|
26
|
+
return;
|
|
27
|
+
}
|
|
28
|
+
context.report({
|
|
29
|
+
data: {
|
|
30
|
+
iconFilePath,
|
|
31
|
+
iconName,
|
|
32
|
+
},
|
|
33
|
+
messageId: "missingTemplateIconFile",
|
|
34
|
+
node: node,
|
|
35
|
+
});
|
|
36
|
+
},
|
|
37
|
+
};
|
|
38
|
+
},
|
|
39
|
+
meta: {
|
|
40
|
+
docs: {
|
|
41
|
+
configs: [
|
|
42
|
+
"github-actions.configs.workflowTemplateProperties",
|
|
43
|
+
"github-actions.configs.workflowTemplates",
|
|
44
|
+
"github-actions.configs.all",
|
|
45
|
+
],
|
|
46
|
+
description: "require local `iconName` references in workflow-template metadata to point to existing SVG files.",
|
|
47
|
+
recommended: true,
|
|
48
|
+
requiresTypeChecking: false,
|
|
49
|
+
ruleId: "R065",
|
|
50
|
+
ruleNumber: 65,
|
|
51
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-template-icon-file-exists",
|
|
52
|
+
},
|
|
53
|
+
messages: {
|
|
54
|
+
missingTemplateIconFile: "Template `iconName` '{{iconName}}' should resolve to an existing icon file at '{{iconFilePath}}'.",
|
|
55
|
+
},
|
|
56
|
+
schema: [],
|
|
57
|
+
type: "problem",
|
|
58
|
+
},
|
|
59
|
+
};
|
|
60
|
+
export default rule;
|
|
61
|
+
//# sourceMappingURL=require-template-icon-file-exists.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-icon-file-exists.js","sourceRoot":"","sources":["../../src/rules/require-template-icon-file-exists.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,UAAU,EAAE,MAAM,SAAS,CAAC;AACrC,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,MAAM,WAAW,CAAC;AAE1C,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EACH,iCAAiC,EACjC,iCAAiC,GACpC,MAAM,8CAA8C,CAAC;AAEtD,mEAAmE;AACnE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;gBAExD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,iCAAiC,CAC9C,IAAI,EACJ,UAAU,CACb,CAAC;gBAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,KAAK,CAAC,EAAE,CAAC;oBACpD,OAAO;gBACX,CAAC;gBAED,IAAI,QAAQ,CAAC,UAAU,CAAC,UAAU,CAAC,EAAE,CAAC;oBAClC,OAAO;gBACX,CAAC;gBAED,MAAM,YAAY,GAAG,IAAI,CACrB,OAAO,CAAC,OAAO,CAAC,QAAQ,CAAC,EACzB,GAAG,QAAQ,MAAM,CACpB,CAAC;gBAEF,IAAI,UAAU,CAAC,YAAY,CAAC,EAAE,CAAC;oBAC3B,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,IAAI,EAAE;wBACF,YAAY;wBACZ,QAAQ;qBACX;oBACD,SAAS,EAAE,yBAAyB;oBACpC,IAAI,EAAE,IAA4B;iBACrC,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,mDAAmD;gBACnD,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,mGAAmG;YACvG,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,0GAA0G;SAClH;QACD,QAAQ,EAAE;YACN,uBAAuB,EACnB,mGAAmG;SAC1G;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,SAAS;KACG;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require `iconName` in workflow-template properties.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring `iconName` in template properties metadata. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-template-icon-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-icon-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-template-icon-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAQnC,oFAAoF;AACpF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAoDhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { isWorkflowTemplatePropertiesFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getWorkflowTemplatePropertiesRoot, getWorkflowTemplateStringProperty, } from "../_internal/workflow-template-properties.js";
|
|
3
|
+
/** Rule implementation for requiring `iconName` in template properties metadata. */
|
|
4
|
+
const rule = {
|
|
5
|
+
create(context) {
|
|
6
|
+
return {
|
|
7
|
+
Program(node) {
|
|
8
|
+
if (!isWorkflowTemplatePropertiesFile(context.filename)) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const root = getWorkflowTemplatePropertiesRoot(context);
|
|
12
|
+
if (root === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const iconName = getWorkflowTemplateStringProperty(root, "iconName");
|
|
16
|
+
if (iconName !== null && iconName.trim().length > 0) {
|
|
17
|
+
return;
|
|
18
|
+
}
|
|
19
|
+
context.report({
|
|
20
|
+
messageId: "missingIconName",
|
|
21
|
+
node: node,
|
|
22
|
+
});
|
|
23
|
+
},
|
|
24
|
+
};
|
|
25
|
+
},
|
|
26
|
+
meta: {
|
|
27
|
+
docs: {
|
|
28
|
+
configs: [
|
|
29
|
+
"github-actions.configs.workflowTemplateProperties",
|
|
30
|
+
"github-actions.configs.workflowTemplates",
|
|
31
|
+
"github-actions.configs.all",
|
|
32
|
+
],
|
|
33
|
+
description: "require `iconName` in workflow-template `.properties.json` metadata.",
|
|
34
|
+
recommended: true,
|
|
35
|
+
requiresTypeChecking: false,
|
|
36
|
+
ruleId: "R056",
|
|
37
|
+
ruleNumber: 56,
|
|
38
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-template-icon-name",
|
|
39
|
+
},
|
|
40
|
+
messages: {
|
|
41
|
+
missingIconName: "Workflow template metadata should define a non-empty `iconName`.",
|
|
42
|
+
},
|
|
43
|
+
schema: [],
|
|
44
|
+
type: "suggestion",
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
export default rule;
|
|
48
|
+
//# sourceMappingURL=require-template-icon-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-icon-name.js","sourceRoot":"","sources":["../../src/rules/require-template-icon-name.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,gCAAgC,EAAE,MAAM,8BAA8B,CAAC;AAChF,OAAO,EACH,iCAAiC,EACjC,iCAAiC,GACpC,MAAM,8CAA8C,CAAC;AAEtD,oFAAoF;AACpF,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,gCAAgC,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBACtD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,iCAAiC,CAAC,OAAO,CAAC,CAAC;gBAExD,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,iCAAiC,CAC9C,IAAI,EACJ,UAAU,CACb,CAAC;gBAEF,IAAI,QAAQ,KAAK,IAAI,IAAI,QAAQ,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAClD,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,mDAAmD;gBACnD,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,sEAAsE;YAC1E,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,mGAAmG;SAC3G;QACD,QAAQ,EAAE;YACN,eAAe,EACX,kEAAkE;SACzE;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require template workflow YAML files to declare a non-empty top-level `name`.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring workflow names in template YAML files. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-template-workflow-name.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-workflow-name.d.ts","sourceRoot":"","sources":["../../src/rules/require-template-workflow-name.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AASnC,+EAA+E;AAC/E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAiDhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,48 @@
|
|
|
1
|
+
import { isWorkflowTemplateYamlFile } from "../_internal/lint-targets.js";
|
|
2
|
+
import { getMappingPair, getScalarStringValue, getWorkflowRoot, } from "../_internal/workflow-yaml.js";
|
|
3
|
+
/** Rule implementation for requiring workflow names in template YAML files. */
|
|
4
|
+
const rule = {
|
|
5
|
+
create(context) {
|
|
6
|
+
return {
|
|
7
|
+
Program(node) {
|
|
8
|
+
if (!isWorkflowTemplateYamlFile(context.filename)) {
|
|
9
|
+
return;
|
|
10
|
+
}
|
|
11
|
+
const root = getWorkflowRoot(context);
|
|
12
|
+
if (root === null) {
|
|
13
|
+
return;
|
|
14
|
+
}
|
|
15
|
+
const namePair = getMappingPair(root, "name");
|
|
16
|
+
const workflowName = getScalarStringValue(namePair?.value);
|
|
17
|
+
if (workflowName !== null && workflowName.trim().length > 0) {
|
|
18
|
+
return;
|
|
19
|
+
}
|
|
20
|
+
context.report({
|
|
21
|
+
messageId: "missingTemplateWorkflowName",
|
|
22
|
+
node: (namePair ?? node),
|
|
23
|
+
});
|
|
24
|
+
},
|
|
25
|
+
};
|
|
26
|
+
},
|
|
27
|
+
meta: {
|
|
28
|
+
docs: {
|
|
29
|
+
configs: [
|
|
30
|
+
"github-actions.configs.workflowTemplates",
|
|
31
|
+
"github-actions.configs.all",
|
|
32
|
+
],
|
|
33
|
+
description: "require workflow template YAML files to declare a non-empty top-level `name`.",
|
|
34
|
+
recommended: true,
|
|
35
|
+
requiresTypeChecking: false,
|
|
36
|
+
ruleId: "R067",
|
|
37
|
+
ruleNumber: 67,
|
|
38
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-template-workflow-name",
|
|
39
|
+
},
|
|
40
|
+
messages: {
|
|
41
|
+
missingTemplateWorkflowName: "Workflow template files should declare a non-empty top-level `name`.",
|
|
42
|
+
},
|
|
43
|
+
schema: [],
|
|
44
|
+
type: "suggestion",
|
|
45
|
+
},
|
|
46
|
+
};
|
|
47
|
+
export default rule;
|
|
48
|
+
//# sourceMappingURL=require-template-workflow-name.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-template-workflow-name.js","sourceRoot":"","sources":["../../src/rules/require-template-workflow-name.ts"],"names":[],"mappings":"AAMA,OAAO,EAAE,0BAA0B,EAAE,MAAM,8BAA8B,CAAC;AAC1E,OAAO,EACH,cAAc,EACd,oBAAoB,EACpB,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,+EAA+E;AAC/E,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,OAAO;YACH,OAAO,CAAC,IAAI;gBACR,IAAI,CAAC,0BAA0B,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,CAAC;oBAChD,OAAO;gBACX,CAAC;gBAED,MAAM,IAAI,GAAG,eAAe,CAAC,OAAO,CAAC,CAAC;gBAEtC,IAAI,IAAI,KAAK,IAAI,EAAE,CAAC;oBAChB,OAAO;gBACX,CAAC;gBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;gBAC9C,MAAM,YAAY,GAAG,oBAAoB,CAAC,QAAQ,EAAE,KAAK,CAAC,CAAC;gBAE3D,IAAI,YAAY,KAAK,IAAI,IAAI,YAAY,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;oBAC1D,OAAO;gBACX,CAAC;gBAED,OAAO,CAAC,MAAM,CAAC;oBACX,SAAS,EAAE,6BAA6B;oBACxC,IAAI,EAAE,CAAC,QAAQ,IAAI,IAAI,CAAyB;iBACnD,CAAC,CAAC;YACP,CAAC;SACJ,CAAC;IACN,CAAC;IACD,IAAI,EAAE;QACF,IAAI,EAAE;YACF,OAAO,EAAE;gBACL,0CAA0C;gBAC1C,4BAA4B;aAC/B;YACD,WAAW,EACP,+EAA+E;YACnF,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,uGAAuG;SAC/G;QACD,QAAQ,EAAE;YACN,2BAA2B,EACvB,sEAAsE;SAC7E;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require explicit activity `types` for selected multi-activity workflow events.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit event activity types. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-trigger-types.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-trigger-types.d.ts","sourceRoot":"","sources":["../../src/rules/require-trigger-types.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AA2DnC,uEAAuE;AACvE,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAsHhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,126 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Events where explicit `types` improve trigger precision. */
|
|
3
|
+
const eventsRequiringTypes = new Set([
|
|
4
|
+
"branch_protection_rule",
|
|
5
|
+
"check_run",
|
|
6
|
+
"check_suite",
|
|
7
|
+
"discussion",
|
|
8
|
+
"discussion_comment",
|
|
9
|
+
"issue_comment",
|
|
10
|
+
"issues",
|
|
11
|
+
"label",
|
|
12
|
+
"merge_group",
|
|
13
|
+
"milestone",
|
|
14
|
+
"pull_request_review",
|
|
15
|
+
"pull_request_review_comment",
|
|
16
|
+
"registry_package",
|
|
17
|
+
"release",
|
|
18
|
+
"repository_dispatch",
|
|
19
|
+
"watch",
|
|
20
|
+
"workflow_run",
|
|
21
|
+
]);
|
|
22
|
+
/** Determine whether an event `types` node is meaningfully configured. */
|
|
23
|
+
const hasConfiguredTypes = (node) => {
|
|
24
|
+
const valueNode = unwrapYamlValue(node?.value ?? null);
|
|
25
|
+
if (valueNode === null) {
|
|
26
|
+
return false;
|
|
27
|
+
}
|
|
28
|
+
if (valueNode.type === "YAMLScalar") {
|
|
29
|
+
const value = getScalarStringValue(valueNode);
|
|
30
|
+
return value !== null && value.trim().length > 0;
|
|
31
|
+
}
|
|
32
|
+
if (valueNode.type !== "YAMLSequence") {
|
|
33
|
+
return false;
|
|
34
|
+
}
|
|
35
|
+
return valueNode.entries.some((entry) => {
|
|
36
|
+
const value = getScalarStringValue(entry);
|
|
37
|
+
return value !== null && value.trim().length > 0;
|
|
38
|
+
});
|
|
39
|
+
};
|
|
40
|
+
/** Rule implementation for requiring explicit event activity types. */
|
|
41
|
+
const rule = {
|
|
42
|
+
create(context) {
|
|
43
|
+
const reportMissingTypes = (node, eventName) => {
|
|
44
|
+
context.report({
|
|
45
|
+
data: {
|
|
46
|
+
event: eventName,
|
|
47
|
+
},
|
|
48
|
+
messageId: "missingTypes",
|
|
49
|
+
node: node,
|
|
50
|
+
});
|
|
51
|
+
};
|
|
52
|
+
return {
|
|
53
|
+
Program() {
|
|
54
|
+
const root = getWorkflowRoot(context);
|
|
55
|
+
if (root === null) {
|
|
56
|
+
return;
|
|
57
|
+
}
|
|
58
|
+
const onPair = getMappingPair(root, "on");
|
|
59
|
+
const onValue = unwrapYamlValue(onPair?.value ?? null);
|
|
60
|
+
if (onValue === null) {
|
|
61
|
+
return;
|
|
62
|
+
}
|
|
63
|
+
if (onValue.type === "YAMLScalar") {
|
|
64
|
+
const eventName = getScalarStringValue(onValue);
|
|
65
|
+
if (eventName !== null &&
|
|
66
|
+
eventsRequiringTypes.has(eventName)) {
|
|
67
|
+
reportMissingTypes(onValue, eventName);
|
|
68
|
+
}
|
|
69
|
+
return;
|
|
70
|
+
}
|
|
71
|
+
if (onValue.type === "YAMLSequence") {
|
|
72
|
+
for (const entry of onValue.entries) {
|
|
73
|
+
const eventName = getScalarStringValue(entry);
|
|
74
|
+
if (entry !== null &&
|
|
75
|
+
eventName !== null &&
|
|
76
|
+
eventsRequiringTypes.has(eventName)) {
|
|
77
|
+
reportMissingTypes(entry, eventName);
|
|
78
|
+
}
|
|
79
|
+
}
|
|
80
|
+
return;
|
|
81
|
+
}
|
|
82
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
83
|
+
if (onMapping === null) {
|
|
84
|
+
return;
|
|
85
|
+
}
|
|
86
|
+
for (const pair of onMapping.pairs) {
|
|
87
|
+
const eventName = getScalarStringValue(pair.key);
|
|
88
|
+
if (eventName === null ||
|
|
89
|
+
!eventsRequiringTypes.has(eventName)) {
|
|
90
|
+
continue;
|
|
91
|
+
}
|
|
92
|
+
const eventValue = unwrapYamlValue(pair.value);
|
|
93
|
+
if (eventValue?.type !== "YAMLMapping") {
|
|
94
|
+
reportMissingTypes((pair.value ?? pair.key), eventName);
|
|
95
|
+
continue;
|
|
96
|
+
}
|
|
97
|
+
if (hasConfiguredTypes(getMappingPair(eventValue, "types"))) {
|
|
98
|
+
continue;
|
|
99
|
+
}
|
|
100
|
+
reportMissingTypes(eventValue, eventName);
|
|
101
|
+
}
|
|
102
|
+
},
|
|
103
|
+
};
|
|
104
|
+
},
|
|
105
|
+
meta: {
|
|
106
|
+
docs: {
|
|
107
|
+
configs: [
|
|
108
|
+
"github-actions.configs.all",
|
|
109
|
+
"github-actions.configs.strict",
|
|
110
|
+
],
|
|
111
|
+
description: "require explicit `types` filters for selected multi-activity workflow events so workflows do not subscribe to every supported activity implicitly.",
|
|
112
|
+
recommended: false,
|
|
113
|
+
requiresTypeChecking: false,
|
|
114
|
+
ruleId: "R031",
|
|
115
|
+
ruleNumber: 31,
|
|
116
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-trigger-types",
|
|
117
|
+
},
|
|
118
|
+
messages: {
|
|
119
|
+
missingTypes: "`on.{{event}}` should declare a non-empty `types` filter so the workflow is scoped to explicit activity types.",
|
|
120
|
+
},
|
|
121
|
+
schema: [],
|
|
122
|
+
type: "suggestion",
|
|
123
|
+
},
|
|
124
|
+
};
|
|
125
|
+
export default rule;
|
|
126
|
+
//# sourceMappingURL=require-trigger-types.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-trigger-types.js","sourceRoot":"","sources":["../../src/rules/require-trigger-types.ts"],"names":[],"mappings":"AAOA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,+DAA+D;AAC/D,MAAM,oBAAoB,GAAG,IAAI,GAAG,CAAS;IACzC,wBAAwB;IACxB,WAAW;IACX,aAAa;IACb,YAAY;IACZ,oBAAoB;IACpB,eAAe;IACf,QAAQ;IACR,OAAO;IACP,aAAa;IACb,WAAW;IACX,qBAAqB;IACrB,6BAA6B;IAC7B,kBAAkB;IAClB,SAAS;IACT,qBAAqB;IACrB,OAAO;IACP,cAAc;CACjB,CAAC,CAAC;AAEH,0EAA0E;AAC1E,MAAM,kBAAkB,GAAG,CACvB,IAA+C,EACxC,EAAE;IACT,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;IAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;QACrB,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;QAClC,MAAM,KAAK,GAAG,oBAAoB,CAAC,SAAS,CAAC,CAAC;QAE9C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;QACpC,OAAO,KAAK,CAAC;IACjB,CAAC;IAED,OAAO,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE;QACpC,MAAM,KAAK,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;QAE1C,OAAO,KAAK,KAAK,IAAI,IAAI,KAAK,CAAC,IAAI,EAAE,CAAC,MAAM,GAAG,CAAC,CAAC;IACrD,CAAC,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,uEAAuE;AACvE,MAAM,IAAI,GAAoB;IAC1B,MAAM,CAAC,OAAO;QACV,MAAM,kBAAkB,GAAG,CACvB,IAA4B,EAC5B,SAAiB,EACb,EAAE;YACN,OAAO,CAAC,MAAM,CAAC;gBACX,IAAI,EAAE;oBACF,KAAK,EAAE,SAAS;iBACnB;gBACD,SAAS,EAAE,cAAc;gBACzB,IAAI,EAAE,IAA4B;aACrC,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,MAAM,GAAG,cAAc,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAC1C,MAAM,OAAO,GAAG,eAAe,CAAC,MAAM,EAAE,KAAK,IAAI,IAAI,CAAC,CAAC;gBAEvD,IAAI,OAAO,KAAK,IAAI,EAAE,CAAC;oBACnB,OAAO;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,IAAI,KAAK,YAAY,EAAE,CAAC;oBAChC,MAAM,SAAS,GAAG,oBAAoB,CAAC,OAAO,CAAC,CAAC;oBAEhD,IACI,SAAS,KAAK,IAAI;wBAClB,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,EACrC,CAAC;wBACC,kBAAkB,CAAC,OAAO,EAAE,SAAS,CAAC,CAAC;oBAC3C,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,IAAI,OAAO,CAAC,IAAI,KAAK,cAAc,EAAE,CAAC;oBAClC,KAAK,MAAM,KAAK,IAAI,OAAO,CAAC,OAAO,EAAE,CAAC;wBAClC,MAAM,SAAS,GAAG,oBAAoB,CAAC,KAAK,CAAC,CAAC;wBAE9C,IACI,KAAK,KAAK,IAAI;4BACd,SAAS,KAAK,IAAI;4BAClB,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,EACrC,CAAC;4BACC,kBAAkB,CAAC,KAAK,EAAE,SAAS,CAAC,CAAC;wBACzC,CAAC;oBACL,CAAC;oBAED,OAAO;gBACX,CAAC;gBAED,MAAM,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACrB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,SAAS,CAAC,KAAK,EAAE,CAAC;oBACjC,MAAM,SAAS,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAEjD,IACI,SAAS,KAAK,IAAI;wBAClB,CAAC,oBAAoB,CAAC,GAAG,CAAC,SAAS,CAAC,EACtC,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,MAAM,UAAU,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAE/C,IAAI,UAAU,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;wBACrC,kBAAkB,CACd,CAAC,IAAI,CAAC,KAAK,IAAI,IAAI,CAAC,GAAG,CAAiB,EACxC,SAAS,CACZ,CAAC;wBAEF,SAAS;oBACb,CAAC;oBAED,IACI,kBAAkB,CAAC,cAAc,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC,EACzD,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,kBAAkB,CAAC,UAAU,EAAE,SAAS,CAAC,CAAC;gBAC9C,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,oJAAoJ;YACxJ,WAAW,EAAE,KAAK;YAClB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,8FAA8F;SACtG;QACD,QAAQ,EAAE;YACN,YAAY,EACR,gHAAgH;SACvH;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require explicit types for reusable workflow inputs.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit workflow_call input types. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-call-input-type.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-call-input-type.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-call-input-type.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAsBnC,4EAA4E;AAC5E,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAuGhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,89 @@
|
|
|
1
|
+
import { getMappingPair, getMappingValueAsMapping, getScalarStringValue, getWorkflowRoot, unwrapYamlValue, } from "../_internal/workflow-yaml.js";
|
|
2
|
+
/** Allowed GitHub reusable workflow input types. */
|
|
3
|
+
const allowedWorkflowCallInputTypes = [
|
|
4
|
+
"boolean",
|
|
5
|
+
"number",
|
|
6
|
+
"string",
|
|
7
|
+
];
|
|
8
|
+
/** Constant-time lookup for supported reusable workflow input types. */
|
|
9
|
+
const allowedWorkflowCallInputTypeSet = new Set(allowedWorkflowCallInputTypes);
|
|
10
|
+
/** Rule implementation for requiring explicit workflow_call input types. */
|
|
11
|
+
const rule = {
|
|
12
|
+
create(context) {
|
|
13
|
+
return {
|
|
14
|
+
Program() {
|
|
15
|
+
const root = getWorkflowRoot(context);
|
|
16
|
+
if (root === null) {
|
|
17
|
+
return;
|
|
18
|
+
}
|
|
19
|
+
const onMapping = getMappingValueAsMapping(root, "on");
|
|
20
|
+
if (onMapping === null) {
|
|
21
|
+
return;
|
|
22
|
+
}
|
|
23
|
+
const workflowCallMapping = unwrapYamlValue(getMappingPair(onMapping, "workflow_call")?.value ?? null);
|
|
24
|
+
if (workflowCallMapping?.type !== "YAMLMapping") {
|
|
25
|
+
return;
|
|
26
|
+
}
|
|
27
|
+
const inputsMapping = getMappingValueAsMapping(workflowCallMapping, "inputs");
|
|
28
|
+
if (inputsMapping === null) {
|
|
29
|
+
return;
|
|
30
|
+
}
|
|
31
|
+
for (const pair of inputsMapping.pairs) {
|
|
32
|
+
const inputId = getScalarStringValue(pair.key);
|
|
33
|
+
const inputMapping = unwrapYamlValue(pair.value);
|
|
34
|
+
if (inputId === null ||
|
|
35
|
+
inputMapping?.type !== "YAMLMapping") {
|
|
36
|
+
continue;
|
|
37
|
+
}
|
|
38
|
+
const typePair = getMappingPair(inputMapping, "type");
|
|
39
|
+
if (typePair === null) {
|
|
40
|
+
context.report({
|
|
41
|
+
data: {
|
|
42
|
+
inputId,
|
|
43
|
+
},
|
|
44
|
+
messageId: "missingType",
|
|
45
|
+
node: pair.key,
|
|
46
|
+
});
|
|
47
|
+
continue;
|
|
48
|
+
}
|
|
49
|
+
const typeValue = getScalarStringValue(typePair.value);
|
|
50
|
+
if (typeValue === null ||
|
|
51
|
+
!allowedWorkflowCallInputTypeSet.has(typeValue)) {
|
|
52
|
+
context.report({
|
|
53
|
+
data: {
|
|
54
|
+
allowedTypes: allowedWorkflowCallInputTypes.join(", "),
|
|
55
|
+
inputId,
|
|
56
|
+
},
|
|
57
|
+
messageId: "invalidType",
|
|
58
|
+
node: (typePair.value ??
|
|
59
|
+
typePair),
|
|
60
|
+
});
|
|
61
|
+
}
|
|
62
|
+
}
|
|
63
|
+
},
|
|
64
|
+
};
|
|
65
|
+
},
|
|
66
|
+
meta: {
|
|
67
|
+
docs: {
|
|
68
|
+
configs: [
|
|
69
|
+
"github-actions.configs.all",
|
|
70
|
+
"github-actions.configs.recommended",
|
|
71
|
+
"github-actions.configs.strict",
|
|
72
|
+
],
|
|
73
|
+
description: "require every `workflow_call` input to declare one of the documented reusable-workflow input types so callers and validators agree on interface semantics.",
|
|
74
|
+
recommended: true,
|
|
75
|
+
requiresTypeChecking: false,
|
|
76
|
+
ruleId: "R034",
|
|
77
|
+
ruleNumber: 34,
|
|
78
|
+
url: "https://nick2bad4u.github.io/eslint-plugin-github-actions-2/docs/rules/require-workflow-call-input-type",
|
|
79
|
+
},
|
|
80
|
+
messages: {
|
|
81
|
+
invalidType: "`workflow_call` input '{{inputId}}' must set `type` to one of: {{allowedTypes}}.",
|
|
82
|
+
missingType: "`workflow_call` input '{{inputId}}' should declare `type` explicitly.",
|
|
83
|
+
},
|
|
84
|
+
schema: [],
|
|
85
|
+
type: "suggestion",
|
|
86
|
+
},
|
|
87
|
+
};
|
|
88
|
+
export default rule;
|
|
89
|
+
//# sourceMappingURL=require-workflow-call-input-type.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-call-input-type.js","sourceRoot":"","sources":["../../src/rules/require-workflow-call-input-type.ts"],"names":[],"mappings":"AAMA,OAAO,EACH,cAAc,EACd,wBAAwB,EACxB,oBAAoB,EACpB,eAAe,EACf,eAAe,GAClB,MAAM,+BAA+B,CAAC;AAEvC,oDAAoD;AACpD,MAAM,6BAA6B,GAAG;IAClC,SAAS;IACT,QAAQ;IACR,QAAQ;CACF,CAAC;AAEX,wEAAwE;AACxE,MAAM,+BAA+B,GAAwB,IAAI,GAAG,CAChE,6BAA6B,CAChC,CAAC;AAEF,4EAA4E;AAC5E,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,SAAS,GAAG,wBAAwB,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC;gBAEvD,IAAI,SAAS,KAAK,IAAI,EAAE,CAAC;oBACrB,OAAO;gBACX,CAAC;gBAED,MAAM,mBAAmB,GAAG,eAAe,CACvC,cAAc,CAAC,SAAS,EAAE,eAAe,CAAC,EAAE,KAAK,IAAI,IAAI,CAC5D,CAAC;gBAEF,IAAI,mBAAmB,EAAE,IAAI,KAAK,aAAa,EAAE,CAAC;oBAC9C,OAAO;gBACX,CAAC;gBAED,MAAM,aAAa,GAAG,wBAAwB,CAC1C,mBAAmB,EACnB,QAAQ,CACX,CAAC;gBAEF,IAAI,aAAa,KAAK,IAAI,EAAE,CAAC;oBACzB,OAAO;gBACX,CAAC;gBAED,KAAK,MAAM,IAAI,IAAI,aAAa,CAAC,KAAK,EAAE,CAAC;oBACrC,MAAM,OAAO,GAAG,oBAAoB,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;oBAC/C,MAAM,YAAY,GAAG,eAAe,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC;oBAEjD,IACI,OAAO,KAAK,IAAI;wBAChB,YAAY,EAAE,IAAI,KAAK,aAAa,EACtC,CAAC;wBACC,SAAS;oBACb,CAAC;oBAED,MAAM,QAAQ,GAAG,cAAc,CAAC,YAAY,EAAE,MAAM,CAAC,CAAC;oBAEtD,IAAI,QAAQ,KAAK,IAAI,EAAE,CAAC;wBACpB,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,OAAO;6BACV;4BACD,SAAS,EAAE,aAAa;4BACxB,IAAI,EAAE,IAAI,CAAC,GAA2B;yBACzC,CAAC,CAAC;wBAEH,SAAS;oBACb,CAAC;oBAED,MAAM,SAAS,GAAG,oBAAoB,CAAC,QAAQ,CAAC,KAAK,CAAC,CAAC;oBAEvD,IACI,SAAS,KAAK,IAAI;wBAClB,CAAC,+BAA+B,CAAC,GAAG,CAAC,SAAS,CAAC,EACjD,CAAC;wBACC,OAAO,CAAC,MAAM,CAAC;4BACX,IAAI,EAAE;gCACF,YAAY,EACR,6BAA6B,CAAC,IAAI,CAAC,IAAI,CAAC;gCAC5C,OAAO;6BACV;4BACD,SAAS,EAAE,aAAa;4BACxB,IAAI,EAAE,CAAC,QAAQ,CAAC,KAAK;gCACjB,QAAQ,CAAyB;yBACxC,CAAC,CAAC;oBACP,CAAC;gBACL,CAAC;YACL,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,4JAA4J;YAChK,WAAW,EAAE,IAAI;YACjB,oBAAoB,EAAE,KAAK;YAC3B,MAAM,EAAE,MAAM;YACd,UAAU,EAAE,EAAE;YACd,GAAG,EAAE,yGAAyG;SACjH;QACD,QAAQ,EAAE;YACN,WAAW,EACP,kFAAkF;YACtF,WAAW,EACP,uEAAuE;SAC9E;QACD,MAAM,EAAE,EAAE;QACV,IAAI,EAAE,YAAY;KACA;CACzB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
/**
|
|
2
|
+
* @packageDocumentation
|
|
3
|
+
* Require reusable workflow outputs to declare a non-empty `value`.
|
|
4
|
+
*/
|
|
5
|
+
import type { Rule } from "eslint";
|
|
6
|
+
/** Rule implementation for requiring explicit reusable-workflow output values. */
|
|
7
|
+
declare const rule: Rule.RuleModule;
|
|
8
|
+
export default rule;
|
|
9
|
+
//# sourceMappingURL=require-workflow-call-output-value.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"require-workflow-call-output-value.d.ts","sourceRoot":"","sources":["../../src/rules/require-workflow-call-output-value.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,OAAO,KAAK,EAAE,IAAI,EAAE,MAAM,QAAQ,CAAC;AAUnC,kFAAkF;AAClF,QAAA,MAAM,IAAI,EAAE,IAAI,CAAC,UAkGhB,CAAC;AAEF,eAAe,IAAI,CAAC"}
|