Exercism AST representer for TypeScript
npm install @exercism/typescript-representer
Clone this repository and then run:
``bash`
yarn install
You'll need at least Node LTS for this to work.
`
yarn build
If you want to use this package as a local tool, you can install it globally, in order to make the "binaries" available:
`shellscript`
yarn global add @exercism/typescript-representer
On \*nix systems or enabled shells (wsl, bash, git bash, etc.) you can now use typescript-representer
If you're developing this, you can run this via yarn or the provided shell script.
- .sh enabled systems (UNIX, WSL): yarn represent:dev
- fallback (cmd.exe, Git Bash for Windows): yarn represent:dev:bat
You'll want these :dev variants because it will _build_ the required code (it will transpile from TypeScript to JavaScript, which is necessary to run this in Node environments, unlike Deno environments)..sh
When on Windows, if you're using Git Bash for Windows or a similar terminal, the files will work, but will open a new window (which closes after execution)..bat
The scripts will work in the same terminal.
You can also manually build using yarn or yarn build, and then run the script directly: ./bin/represent.sh arg1 -o2 --option3.
Run this with the argument help to see how to use this:
`shell
yarn represent:dev:bat help
Usage | represent.js
Options:
... see below
Examples:
represent.js two-fer ~/typescript/two-fer/128/
Represent the two-fer solution from the input directory "~/typescript/two-fer/128"
`
| short | long | description | |
| ------ | ------------------------- | ------------------------------------------------------------------- | -------------------------------------------- |
| | --version | Show version number | boolean |-d
| | --debug | Unless given, only outputs warnings and errors | boolean (default: false) |-c
| | --console | If given, outputs to the console | boolean (default: false) |--or
| | --output_representation | Path relative to the output dir where the representation is stored | string (default: "./representation.txt") |--om
| | --output_mapping | Path relative to the output dir where the mapping is stored | string (default: "./mapping.json") |-u
| | --ugly | If given, does not format the JSON output using 2 space indentation | boolean (default: false) |--dry
| | | If given, does not output anything to disk | boolean (default: false) |-h
| | --help | Show help | boolean |
When using development, likely you'll want -dc to _also_ print the output and debug message to the console.--dry
You can use to prevent the script from writing to disk.
When the is not given, it default to the given
There are tools provided to run the representer on remote solutions.
- .sh enabled systems (UNIX, WSL): bin/scripts/remote.sh url
- fallback (cmd.exe, Git Bash for Windows): bin\scripts\remote.bat url
You can pass the following type of URLs:
- Published solutions: /tracks/typescript/exercises/
- Mentor solutions:
- Your solutions:
- Private solutions:
To create the image, execute the following command from the repository root:
`bash`
docker build -t exercism/typescript-representer .
To run from docker pass in the solutions path as a volume and execute with the necessary parameters:
`bash`
docker run -v $(PATH_TO_SOLUTION):/solution exercism/typescript-representer ${SLUG} /solution
Example:
`bash`
docker run -v ~/solution-238382y7sds7fsadfasj23j:/solution exercism/typescript-representer two-fer /solution
The easiest way to satisfy the code-format linter is to add a comment to your PR:
`text`
/format
Alternatively, run the following command:
`shell``Ensure that the version matches the version inside .github/format-code.yml
EXERCISM_PRETTIER_VERSION=2.2.1 bin/format.sh