generated from actions/typescript-action
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
35 changed files
with
2,179 additions
and
1,279 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,4 +1,4 @@ | ||
dist/ | ||
lib/ | ||
dist/ | ||
node_modules/ | ||
jest.config.js | ||
coverage/ |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,3 @@ | ||
dist/** -diff linguist-generated=true | ||
* text=auto eol=lf | ||
|
||
dist/** -diff linguist-generated=true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,83 @@ | ||
env: | ||
node: true | ||
es6: true | ||
jest: true | ||
|
||
globals: | ||
Atomics: readonly | ||
SharedArrayBuffer: readonly | ||
|
||
ignorePatterns: | ||
- '!.*' | ||
- '**/node_modules/.*' | ||
- '**/dist/.*' | ||
- '**/coverage/.*' | ||
- '*.json' | ||
|
||
parser: '@typescript-eslint/parser' | ||
|
||
parserOptions: | ||
ecmaVersion: 2023 | ||
sourceType: module | ||
project: | ||
- './.github/linters/tsconfig.json' | ||
- './tsconfig.json' | ||
|
||
plugins: | ||
- jest | ||
- '@typescript-eslint' | ||
|
||
extends: | ||
- eslint:recommended | ||
- plugin:@typescript-eslint/eslint-recommended | ||
- plugin:@typescript-eslint/recommended | ||
- plugin:github/recommended | ||
- plugin:jest/recommended | ||
|
||
rules: | ||
{ | ||
'camelcase': 'off', | ||
'eslint-comments/no-use': 'off', | ||
'eslint-comments/no-unused-disable': 'off', | ||
'i18n-text/no-en': 'off', | ||
'import/no-namespace': 'off', | ||
'no-console': 'off', | ||
'no-unused-vars': 'off', | ||
'prettier/prettier': 'error', | ||
'semi': 'off', | ||
'@typescript-eslint/array-type': 'error', | ||
'@typescript-eslint/await-thenable': 'error', | ||
'@typescript-eslint/ban-ts-comment': 'error', | ||
'@typescript-eslint/consistent-type-assertions': 'error', | ||
'@typescript-eslint/explicit-member-accessibility': | ||
['error', { 'accessibility': 'no-public' }], | ||
'@typescript-eslint/explicit-function-return-type': | ||
['error', { 'allowExpressions': true }], | ||
'@typescript-eslint/func-call-spacing': ['error', 'never'], | ||
'@typescript-eslint/no-array-constructor': 'error', | ||
'@typescript-eslint/no-empty-interface': 'error', | ||
'@typescript-eslint/no-explicit-any': 'off', | ||
'@typescript-eslint/no-extraneous-class': 'error', | ||
'@typescript-eslint/no-for-in-array': 'error', | ||
'@typescript-eslint/no-inferrable-types': 'error', | ||
'@typescript-eslint/no-misused-new': 'error', | ||
'@typescript-eslint/no-namespace': 'error', | ||
'@typescript-eslint/no-non-null-assertion': 'warn', | ||
'@typescript-eslint/no-require-imports': 'error', | ||
'@typescript-eslint/no-unnecessary-qualifier': 'error', | ||
'@typescript-eslint/no-unnecessary-type-assertion': 'error', | ||
'@typescript-eslint/no-unused-vars': 'error', | ||
'@typescript-eslint/no-useless-constructor': 'error', | ||
'@typescript-eslint/no-var-requires': 'error', | ||
'@typescript-eslint/prefer-for-of': 'warn', | ||
'@typescript-eslint/prefer-function-type': 'warn', | ||
'@typescript-eslint/prefer-includes': 'error', | ||
'@typescript-eslint/prefer-string-starts-ends-with': 'error', | ||
'@typescript-eslint/promise-function-async': 'error', | ||
'@typescript-eslint/require-array-sort-compare': 'error', | ||
'@typescript-eslint/restrict-plus-operands': 'error', | ||
'@typescript-eslint/semi': ['error', 'never'], | ||
'@typescript-eslint/space-before-function-paren': 'off', | ||
'@typescript-eslint/type-annotation-spacing': 'error', | ||
'@typescript-eslint/unbound-method': 'error' | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,18 @@ | ||
# Unordered list style | ||
MD004: | ||
style: dash | ||
|
||
# Ordered list item prefix | ||
MD029: | ||
style: one | ||
|
||
# Spaces after list markers | ||
MD030: | ||
ul_single: 1 | ||
ol_single: 1 | ||
ul_multi: 1 | ||
ol_multi: 1 | ||
|
||
# Code block style | ||
MD046: | ||
style: fenced |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,10 @@ | ||
rules: | ||
document-end: disable | ||
document-start: | ||
level: warning | ||
present: false | ||
line-length: | ||
level: warning | ||
max: 80 | ||
allow-non-breakable-words: true | ||
allow-non-breakable-inline-mappings: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,9 @@ | ||
{ | ||
"$schema": "https://json.schemastore.org/tsconfig", | ||
"extends": "../../tsconfig.json", | ||
"compilerOptions": { | ||
"noEmit": true | ||
}, | ||
"include": ["../../__tests__/**/*", "../../src/**/*"], | ||
"exclude": ["../../dist", "../../node_modules", "../../coverage", "*.json"] | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,45 +1,72 @@ | ||
# `dist/index.js` is a special file in Actions. | ||
# When you reference an action with `uses:` in a workflow, | ||
# `index.js` is the code that will run. | ||
# For our project, we generate this file through a build process from other source files. | ||
# We need to make sure the checked-in `index.js` actually matches what we expect it to be. | ||
name: Check dist/ | ||
# In TypeScript actions, `dist/` is a special directory. When you reference | ||
# an action with the `uses:` property, `dist/index.js` is the code that will be | ||
# run. For this project, the `dist/index.js` file is transpiled from other | ||
# source files. This workflow ensures the `dist/` directory contains the | ||
# expected transpiled code. | ||
# | ||
# If this workflow is run from a feature branch, it will act as an additional CI | ||
# check and fail if the checked-in `dist/` directory does not match what is | ||
# expected from the build. | ||
name: Check Transpiled JavaScript | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
push: | ||
branches: | ||
- main | ||
paths-ignore: | ||
- '**.md' | ||
pull_request: | ||
paths-ignore: | ||
- '**.md' | ||
workflow_dispatch: | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
check-dist: | ||
name: Check dist/ | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- uses: actions/checkout@v4 | ||
- name: Set Node.js 16.x | ||
- name: Checkout | ||
id: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup Node.js | ||
id: setup-node | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version: 18 | ||
- name: Install dependencies | ||
node-version-file: .node-version | ||
cache: npm | ||
|
||
- name: Install Dependencies | ||
id: install | ||
run: npm ci | ||
- name: Rebuild the dist/ directory | ||
run: | | ||
npm run build | ||
npm run package | ||
- name: Compare the expected and actual dist/ directories | ||
|
||
- name: Build dist/ Directory | ||
id: build | ||
run: npm run bundle | ||
|
||
# This will fail the workflow if the `dist/` directory is different than | ||
# expected. | ||
- name: Compare Directories | ||
id: diff | ||
run: | | ||
if [ "$(git diff --ignore-space-at-eol dist/ | wc -l)" -gt "0" ]; then | ||
echo "Detected uncommitted changes after build. See status below:" | ||
git diff | ||
if [ ! -d dist/ ]; then | ||
echo "Expected dist/ directory does not exist. See status below:" | ||
ls -la ./ | ||
exit 1 | ||
fi | ||
id: diff | ||
# If index.js was different than expected, upload the expected version as an artifact | ||
- uses: actions/upload-artifact@v4 | ||
if: ${{ failure() && steps.diff.conclusion == 'failure' }} | ||
if [ "$(git diff --ignore-space-at-eol --text dist/ | wc -l)" -gt "0" ]; then | ||
echo "Detected uncommitted changes after build. See status below:" | ||
git diff --ignore-space-at-eol --text dist/ | ||
exit 1 | ||
fi | ||
# If `dist/` was different than expected, upload the expected version as a | ||
# workflow artifact. | ||
- if: ${{ failure() && steps.diff.outcome == 'failure' }} | ||
name: Upload Artifact | ||
id: upload | ||
uses: actions/upload-artifact@v4 | ||
with: | ||
name: dist | ||
path: dist/ |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,64 @@ | ||
name: Continuous Integration | ||
|
||
on: | ||
pull_request: | ||
branches: | ||
- main | ||
push: | ||
branches: | ||
- main | ||
|
||
permissions: | ||
contents: read | ||
|
||
jobs: | ||
test-typescript: | ||
name: TypeScript Tests | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
id: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Setup Node.js | ||
id: setup-node | ||
uses: actions/setup-node@v4 | ||
with: | ||
node-version-file: .node-version | ||
cache: npm | ||
|
||
- name: Install Dependencies | ||
id: npm-ci | ||
run: npm ci | ||
|
||
- name: Check Format | ||
id: npm-format-check | ||
run: npm run format:check | ||
|
||
- name: Lint | ||
id: npm-lint | ||
run: npm run lint | ||
|
||
- name: Test | ||
id: npm-ci-test | ||
run: npm run ci-test | ||
|
||
test-action: | ||
name: GitHub Actions Test | ||
runs-on: ubuntu-latest | ||
|
||
steps: | ||
- name: Checkout | ||
id: checkout | ||
uses: actions/checkout@v4 | ||
|
||
- name: Test Local Action | ||
id: test-action | ||
uses: ./ | ||
with: | ||
milliseconds: 2000 | ||
|
||
- name: Print Output | ||
id: output | ||
run: echo "${{ steps.test-action.outputs.time }}" |
Oops, something went wrong.