ditkrg/todo-to-issue-action
5
0
Fork 0
mirror of https://github.com/ditkrg/todo-to-issue-action.git synced 2026-01-25 07:16:42 +00:00
Code Issues Packages Projects Releases Wiki Activity

fix: Clean up TeX syntax and add tests

Browse Source 
1. Swap `\` for `\\` for TeX block comments to avoid issues with parsing
2. Add tests for TeX, Julia, AutoHotKey, Org mode, and Handlebars
3. Ensure tests can be run with 1 line command
4. Change logic in test framework so that tests run off of local version
   of `syntax.json` rather than remote version
5. Add details for running tests + adding tests for your syntax PR to
   readme
6. Add .gitignore file for python (to avoid compiles form tests winding
   up in commits)
This commit is contained in:
Quinn Winters
2021-12-13 19:10:28 +01:00
parent 283da1a7cc
commit 4dca8a215f
7 changed files with 326 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@@ -102,7 +102,7 @@ There are additional inputs if you want to be able to assign issues to projects.
* Vue
* YAML
New languages can easily be added to the `syntax.json` file used by the action to identify TODO comments. When adding languages, follow the structure of existing entries, and use the language name defined by GitHub in [`languages.yml`](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml). PRs adding new languages are welcome and appreciated.
New languages can easily be added to the `syntax.json` file used by the action to identify TODO comments. When adding languages, follow the structure of existing entries, and use the language name defined by GitHub in [`languages.yml`](https://raw.githubusercontent.com/github/linguist/master/lib/linguist/languages.yml). PRs adding new languages are welcome and appreciated. Please add a test for your language in order for your PR to be accepted.
## TODO Options
@@ -173,6 +173,14 @@ Issues are created whenever the action runs and finds a newly added TODO in the
If you do encounter any problems, please file an issue or submit a PR. Everyone is welcome and encouraged to contribute.
## Running tests locally
To run the tests locally, simply run the following in the main repo:
```shell
python -m unittest
```
## Thanks
The action was developed for the GitHub Hackathon. Whilst every effort is made to ensure it works, it comes with no guarantee.