Support for TSConfig Paths

.env.example

@@ -4,5 +4,6 @@
 # GitHub Actions inputs should follow `INPUT_<name>` format (case-insensitive).
 INPUT_milliseconds=2400
 
-# Enable/disable step debug logs
-ACTIONS_STEP_DEBUG=false
+# Enable/disable step debug logging. Normally this is false by default, but for
+# the purpose of debugging, it is set to true here.
+ACTIONS_STEP_DEBUG=true

.eslintignore

@@ -1,4 +1,9 @@
+.github/
+.vscode/
+badges/
+bin/
+coverage/
 dist/
 node_modules/
-coverage/
+reports/
 *.json

.eslintrc.yml

@@ -7,10 +7,6 @@ globals:
   Atomics: readonly
   SharedArrayBuffer: readonly
 
-ignorePatterns:
-  - node_modules/.*
-  - coverage/.*
-
 parser: '@typescript-eslint/parser'
 
 parserOptions:
@@ -38,11 +34,9 @@ extends:
 rules:
   {
     '@typescript-eslint/no-explicit-any': 'off',
-    '@typescript-eslint/no-var-requires': 'off',
     'camelcase': 'off',
     'eslint-comments/no-use': 'off',
     'i18n-text/no-en': 'off',
-    'import/no-namespace': 'off',
     'no-console': 'off',
     'no-unused-vars': 'off'
   }

.prettierignore

@@ -1,3 +1,4 @@
+coverage/
 dist/
 node_modules/
-coverage/
+reports/

.prettierrc.yml

@@ -1,14 +1,14 @@
+arrowParens: avoid
+bracketSameLine: true
+bracketSpacing: true
+endOfLine: lf
+htmlWhitespaceSensitivity: css
+jsxSingleQuote: false
 printWidth: 80
-tabWidth: 2
-useTabs: false
+proseWrap: always
+quoteProps: as-needed
 semi: false
 singleQuote: true
-quoteProps: as-needed
-jsxSingleQuote: false
+tabWidth: 2
 trailingComma: none
-bracketSpacing: true
-bracketSameLine: true
-arrowParens: avoid
-proseWrap: always
-htmlWhitespaceSensitivity: css
-endOfLine: lf
+useTabs: false

CONTRIBUTING.md

@@ -1,6 +1,7 @@
 # Contributing
 
-All contributions are welcome and greatly appreciated!
+All contributions are welcome and greatly appreciated! However, please try to
+keep them limited in scope so that they can be more easily reviewed.
 
 ## Steps to Contribute
 
@@ -13,16 +14,23 @@ All contributions are welcome and greatly appreciated!
 > version automatically.
 
 1. Fork this repository
+1. Clone your fork
+1. Install the dependencies with `npm install`
+1. Make and test your changes
 1. Commit your changes
-1. Test your changes
-1. Make sure to run `npm run all` before committing your final changes!
+
+   Make sure to do the following when you commit your changes:
+
+   - Increase the version number in [`package.json`](./package.json)
+   - Run `npm install` to ensure dependencies are up to date
+   - Run `npm run all` to run formatting, linting, etc.
+
 1. Open a pull request back to this repository
 1. Notify the maintainers of this repository for peer review and approval
 1. Merge :tada:
 
 The maintainers of this repository will create a new release with your changes
-so that everyone can use the new release and enjoy the awesome features of
-branch deployments!
+so that everyone can enjoy your contributions!
 
 ## Testing
 
@@ -37,7 +45,7 @@ This project requires **100%** test coverage.
 ### Testing Local Updates
 
 As you make changes, it's a great idea to run the `local-action` tool regularly
-against any testing repositories.
+against various repositories with different configurations.
 
 1. Symlink your package folder (this should only need to be done once)
 
@@ -60,9 +68,35 @@ Once you're finished testing, make sure to unlink!
 npm unlink @github/local-action
 ```
 
+#### Example Actions to Test
+
+After making updates and running the test suite, please also make sure to test
+your updates using the following GitHub Actions repositories:
+
+- [`actions/javascript-action`](https://github.com/actions/javascript-action)
+- [`actions/typescript-action`](https://github.com/actions/typescript-action)
+
+1. Clone each repository locally
+1. From your `github/local-action` fork, test each action
+
+   ```bash
+   npm exec local-action \
+   "/<action repository clone path>/typescript-action" \
+   "src/index.ts" \
+   "<path to your .env file>"
+
+   npm exec local-action \
+   "/<action repository clone path>/javascript-action" \
+   "src/index.ts" \
+   "<path to your .env file>"
+   ```
+
+   For an example `.env` file to use for testing, see
+   [`.env.example`](./.env.example).
+
 ### Running the Test Suite
 
-Simply run the following command to execute the entire test suite:
+Simply run the following command to invoke the entire test suite:
 
 ```bash
 npm run test

README.md

@@ -14,12 +14,18 @@ actions can be run directly on your workstation.
 >
 > This tool currently only supports JavaScript and TypeScript actions!
 
+## v1.0.0 Changes
+
+With the release of `v1.0.0`, there was a need to switch from
+[`ts-node`](https://www.npmjs.com/package/ts-node) to
+[`tsx`](https://www.npmjs.com/package/tsx). However, the bundled version of
+`tsx` is being used, so you should no longer need to install either :grinning:
+
 ## Prerequisites
 
 ### Installed Tools
 
 - [Node.js and npm](https://nodejs.org/en)
-- [`ts-node`](https://www.npmjs.com/package/ts-node)
 
 ### Action Structure
 
@@ -72,23 +78,24 @@ the following when preparing for release:
 
 - Commit the `node_modules` directory to your repository
 - Transpile your code and dependencies using tools like
+  [`tsc`](https://www.typescriptlang.org/docs/handbook/compiler-options.html) or
   [`@vercel/ncc`](https://www.npmjs.com/package/@vercel/ncc)
 
-Currently, this tool supports **non-transpiled action code only**. This is
-because it uses [`proxyquire`](https://github.com/thlorenz/proxyquire) to
-override GitHub Actions Toolkit dependencies (e.g
+**This tool supports non-transpiled action code only.** This is because it uses
+[`proxyquire`](https://github.com/thlorenz/proxyquire) to override GitHub
+Actions Toolkit dependencies (e.g
 [`@actions/core`](https://www.npmjs.com/package/@actions/core)). In transpiled
 code, this simply doesn't work.
 
 For example, if you have a TypeScript action that follows the same format as the
 [template](https://github.com/actions/typescript-action), you would have both
 `src` and `dist` directories in your repository. The `dist` directory contains
 the transpiled code with any dependencies included. When running this utility,
-you will want to target the code files in the `src` directory instead. This has
-the added benefit of being able to hook into debugging utilities in your IDE
-:tada:
+you will want to target the code files in the `src` directory instead (including
+the dependencies this tool wants to replace). This has the added benefit of
+being able to hook into debugging utilities in your IDE :tada:
 
-For additional information, see
+For additional information about transpiled action code, see
 [Commit, tag, and push your action to GitHub](https://docs.github.com/en/actions/creating-actions/creating-a-javascript-action#commit-tag-and-push-your-action-to-github).
 
 ## Installation
@@ -123,6 +130,12 @@ For additional information, see
    npm i -g .
    ```
 
+   Alternatively, you can link the package if you want to make code changes
+
+   ```bash
+   npm link .
+   ```
+
 ## Commands
 
 ### `local-action`
@@ -132,17 +145,26 @@ For additional information, see
 | `-h`, `--help`    | Display help information    |
 | `-V`, `--version` | Display version information |
 
-### `local-action run <path> <entrypoint> <env file>`
-
-| Argument     | Description                                          |
-| ------------ | ---------------------------------------------------- |
-| `path`       | Path to the local action directory                   |
-|              | Example: `/path/to/action.yml`                       |
-| `entrypoint` | Action entrypoint (relative to the action directory) |
-|              | Example: `src/index.ts`                              |
-| `env file`   | Path to the local `.env` file for action inputs      |
-|              | Example: `/path/to/.env`                             |
-|              | See the example [`.env.example`](.env.example)       |
+### `local-action run <path> <entrypoint> <dotenv file>`
+
+| Argument      | Description                                          |
+| ------------- | ---------------------------------------------------- |
+| `path`        | Path to the local action directory                   |
+|               | Example: `/path/to/action.yml`                       |
+| `entrypoint`  | Action entrypoint (relative to the action directory) |
+|               | Example: `src/index.ts`                              |
+| `dotenv file` | Path to the local `.env` file for action inputs      |
+|               | Example: `/path/to/.env`                             |
+|               | See the example [`.env.example`](.env.example)       |
+
+Examples:
+
+```bash
+local-action run /path/to/typescript-action src/index.ts .env
+
+# The `run` action is invoked by default as well
+local-action /path/to/typescript-action src/index.ts .env
+```
 
 #### Output
 

SUPPORT.md

@@ -1,6 +1,6 @@
 # Support
 
-## How to file issues and get help
+## How to Get Help
 
 This project uses GitHub issues to track bugs and feature requests. Please
 search the existing issues before filing new issues to avoid duplicates. For new
@@ -9,9 +9,10 @@ issues, file your bug or feature request as a new issue.
 For help or questions about using this project, please feel free to submit an
 issue as well.
 
-This project is under active development and maintained by GitHub staff and the
-community. We will do our best to respond to support, feature requests, and
-community questions in a timely manner.
+This project is under development and maintained by GitHub staff and the
+community, however availability is limited . We will do our best to respond to
+support, feature requests, and community questions in a timely manner, but there
+is no "official" support for this project at this time.
 
 ## GitHub Support Policy
 

__fixtures__/javascript/failure/src/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+/* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable import/no-commonjs */
 
 const { run } = require('./main')
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/javascript/failure/src/main.js

@@ -1,8 +1,9 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable import/no-commonjs */
 
 const core = require('@actions/core')
 
-// eslint-disable-next-line @typescript-eslint/require-await
 async function run() {
   core.setFailed('JavaScript Action Failed!')
 }

__fixtures__/javascript/no-import/src/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+/* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable import/no-commonjs */
 
 const { run } = require('./main')
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/javascript/no-import/src/main.js

@@ -1,6 +1,6 @@
+/* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable import/no-commonjs */
 
-// eslint-disable-next-line @typescript-eslint/require-await
 async function run() {
   return
 }

__fixtures__/javascript/success/src/index.js

@@ -1,6 +1,7 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+/* eslint-disable @typescript-eslint/no-var-requires */
 /* eslint-disable import/no-commonjs */
 
 const { run } = require('./main')
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/javascript/success/src/main.js

@@ -1,8 +1,9 @@
+/* eslint-disable @typescript-eslint/no-var-requires */
+/* eslint-disable @typescript-eslint/require-await */
 /* eslint-disable import/no-commonjs */
 
 const core = require('@actions/core')
 
-// eslint-disable-next-line @typescript-eslint/require-await
 async function run() {
   const myInput = core.getInput('myInput')
   core.setOutput('myOutput', myInput)

__fixtures__/typescript/failure/src/index.ts

@@ -1,4 +1,5 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+
 import { run } from './main'
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/typescript/failure/src/main.ts

@@ -1,6 +1,7 @@
-import * as core from '@actions/core'
+/* eslint-disable @typescript-eslint/require-await */
+
+import { setFailed } from '@actions/core'
 
-// eslint-disable-next-line @typescript-eslint/require-await
 export async function run(): Promise<void> {
-  core.setFailed('TypeScript Action Failed!')
+  setFailed('TypeScript Action Failed!')
 }

__fixtures__/typescript/no-import/src/index.ts

@@ -1,4 +1,5 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+
 import { run } from './main'
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/typescript/no-import/src/main.ts

@@ -1,4 +1,5 @@
-// eslint-disable-next-line @typescript-eslint/require-await
+/* eslint-disable @typescript-eslint/require-await */
+
 export async function run(): Promise<void> {
   return
 }

__fixtures__/typescript/success/src/index.ts

@@ -1,4 +1,5 @@
+/* eslint-disable @typescript-eslint/no-floating-promises */
+
 import { run } from './main'
 
-// eslint-disable-next-line @typescript-eslint/no-floating-promises
 run()

__fixtures__/typescript/success/src/main.ts

@@ -1,8 +1,9 @@
-import * as core from '@actions/core'
+/* eslint-disable @typescript-eslint/require-await */
+
+import { getInput, info, setOutput } from '@actions/core'
 
-// eslint-disable-next-line @typescript-eslint/require-await
 export async function run(): Promise<void> {
-  const myInput: string = core.getInput('myInput')
-  core.setOutput('myOutput', myInput)
-  core.info('TypeScript Action Succeeded!')
+  const myInput: string = getInput('myInput')
+  setOutput('myOutput', myInput)
+  info('TypeScript Action Succeeded!')
 }

__mocks__/tsconfig-paths.ts

@@ -0,0 +1,2 @@
+export const loadConfig = jest.fn().mockImplementation()
+export const register = jest.fn().mockImplementation()