{"id":28392131,"url":"https://github.com/afassoftware/typescript-assistant","last_synced_at":"2026-03-09T11:33:31.576Z","repository":{"id":41581532,"uuid":"58672798","full_name":"AFASSoftware/typescript-assistant","owner":"AFASSoftware","description":"Combines and integrates professional TypeScript tools into your project","archived":false,"fork":false,"pushed_at":"2025-04-23T17:15:45.000Z","size":1665,"stargazers_count":8,"open_issues_count":1,"forks_count":3,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-06-07T11:14:00.580Z","etag":null,"topics":["compiler","coverage","formatter","linter","release","typescript","unit-testing"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/AFASSoftware.png","metadata":{"files":{"readme":"readme.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null}},"created_at":"2016-05-12T20:02:41.000Z","updated_at":"2025-04-23T17:15:12.000Z","dependencies_parsed_at":"2024-01-30T14:27:15.454Z","dependency_job_id":"f08f50c6-fc82-4e0d-9cc9-333a0a837091","html_url":"https://github.com/AFASSoftware/typescript-assistant","commit_stats":{"total_commits":661,"total_committers":10,"mean_commits":66.1,"dds":"0.39939485627836613","last_synced_commit":"ea6ed46f50287e2f636940d8bf0a5e7aa9a402e2"},"previous_names":[],"tags_count":312,"template":false,"template_full_name":null,"purl":"pkg:github/AFASSoftware/typescript-assistant","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFASSoftware%2Ftypescript-assistant","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFASSoftware%2Ftypescript-assistant/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFASSoftware%2Ftypescript-assistant/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFASSoftware%2Ftypescript-assistant/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/AFASSoftware","download_url":"https://codeload.github.com/AFASSoftware/typescript-assistant/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/AFASSoftware%2Ftypescript-assistant/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":261982404,"owners_count":23240058,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["compiler","coverage","formatter","linter","release","typescript","unit-testing"],"created_at":"2025-05-31T11:40:59.576Z","updated_at":"2026-03-09T11:33:31.532Z","avatar_url":"https://github.com/AFASSoftware.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"## Introduction\n\nWhile you write TypeScript code, you want it to compile, tests to succeed, \ncode coverage to be upheld and the code should conform to formatting and linting rules. \nThere are already great tools that help you do this. But running them manually can be time-consuming.\n\nIn order to be more productive, we ended up creating TypeScript Assistant, that takes care of running the right tools at the right time.\n\n- Before commit: Check formatting and linting\n- Before push: Compile, run unit test and check coverage\n- After pull: Update packages\n\nIt also adds npm scripts to:\n\n- Fix formatting and linting (`npm run fix`)\n- Release to npm (`npm run release`)\n- Run all tools on save in the background (`npm run assist`)\n- Open code coverage (`npm run coverage-show`)\n- Run continuous integration (`npm run ci`)\n- Clean (`npm run clean`)\n\nRead about the philosophy behind TypeScript Assistant on [our blog](https://dev.afas.nl/blog-dev/typescript-assistant).\n\n## Getting started\n\nYou can try TypeScript Assistant on a new project by running\n```\ngit init \u0026\u0026 npm init \u0026\u0026 npm install typescript-assistant --save-dev -E \u0026\u0026 ./node_modules/.bin/tsa init\n```\n\nOn existing TypeScript projects, you can just run\n```\nnpm install typescript-assistant \u0026\u0026 npm dedupe \u0026\u0026 ./node_modules/.bin/tsa init\n```\n\nTypeScript Assistant will not overwrite any configuration you already have. \n\n## Configuration \n\nNot everything is configurable in TypeScript Assistant.\n\n- `/dist` contains artifacts that get distributed in a release. It is excluded from source control.\n- `/build` contains build output and temporary artifacts. It is excluded from source control.\n- `/test` contains (unit)tests written in mocha\n\nTypeScript Assistant enforces \\n as end-of-line on every platform. \nIt does not have a configuration file of is own, it lets the underlying tools use their own configuration files.\n`tsa init` prepares these files as follows:\n\n- `.editorconfig` - End-of-line and tab size set to 2 spaces\n- `.gitattributes` - End-of-line\n- `.gitignore` - Exclude non-source files\n- `.npmignore` - Configure what gets packaged, only `/dist` and `README.md` \n- `package.json` - Adds scripts for git hooks and tasks provided by TypeScript Assistant. Also contains configuration for `nyc` (code coverage)\n- `src/tsconfig.json` - Strict TypeScript configuration for sources. Output is written to `/dist`\n- `tsconfig.json` -  Lenient TypeScript configuration for unit tests, does not write output. (tests run fine using `ts-node`)\n- `tsfmt.json` - End-of-line and tab size\n- `tslint.json` - Contains the linting rules you prefer. By default it is set to inherit from the AFAS Software rules shipped by TypeScript Assistant. It can\n be modified to suit your needs\n- `tslint.editor.json` - Extends `tslint.json` and disables some rules to make your IDE (vscode/webstorm) easier to work with.\n\nThe folder `/src` is assumed to contain source files, but this can be modified by changing the `tsconfig.json` files and the `nyc` section in `package.json`.\nAll configuration files can be changed as needed.\n\nIf you are creating a browser package, you can get inspiration from [maquette](https://maquettejs.org) on how you can put browser bundles in the `dist` folder \nusing TypeScript \nAssistant.\nSee the `dist` task in the [package.json](https://github.com/AFASSoftware/maquette/blob/master/package.json).\n\n## NOTE\n\nWhen typescript-assistant cannot find some of its dependencies, \nit may be required to run `npm dedupe` which makes sure all required \ndependencies will be located directly under `node_modules` of your project\n\n## Contributing\n\nWe would love to discuss the best practices that TypeScript Assistant is meant to support. \nTo start a discussion you may open an issue.\nWe do not intend to make TypeScript Assistant ultimately flexible to support everyone's needs, \nbut pull requests for improvements are welcome.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fafassoftware%2Ftypescript-assistant","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fafassoftware%2Ftypescript-assistant","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fafassoftware%2Ftypescript-assistant/lists"}