{"id":19838146,"url":"https://github.com/textlint/textlint-rule-template-ts","last_synced_at":"2025-05-01T18:31:05.399Z","repository":{"id":43330618,"uuid":"216224708","full_name":"textlint/textlint-rule-template-ts","owner":"textlint","description":"TEMPLATE repository for textlint rule that is written by TypeScript","archived":false,"fork":false,"pushed_at":"2024-10-24T05:18:16.000Z","size":891,"stargazers_count":2,"open_issues_count":1,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-10-24T23:14:12.545Z","etag":null,"topics":["template","textlint","textlintrule","typescript"],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/textlint.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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,"publiccode":null,"codemeta":null}},"created_at":"2019-10-19T15:06:44.000Z","updated_at":"2024-10-24T05:18:19.000Z","dependencies_parsed_at":"2024-02-11T05:26:55.904Z","dependency_job_id":"1b6dcc96-08b8-4f08-987a-66a5e03051ca","html_url":"https://github.com/textlint/textlint-rule-template-ts","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":"textlint/textlint-rule-template","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-rule-template-ts","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-rule-template-ts/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-rule-template-ts/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Ftextlint-rule-template-ts/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textlint","download_url":"https://codeload.github.com/textlint/textlint-rule-template-ts/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":224269997,"owners_count":17283649,"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":["template","textlint","textlintrule","typescript"],"created_at":"2024-11-12T12:16:53.747Z","updated_at":"2024-11-12T12:16:54.578Z","avatar_url":"https://github.com/textlint.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# textlint-rule template\n\nThis is TEMPLATE REPOSITORY for creating textlint rule.\n\nTypeScript version of \u003chttps://github.com/textlint/textlint-rule-template\u003e\n\n## Install\n\nRequirements:\n\n- Git\n- Node.js 16+\n- npm 8+\n\nUse [create-textlint-rule](https://github.com/textlint/create-textlint-rule):\n\n```\n$ npx create-textlint-rule example --typescript\n```\n\nOr, Run following steps manually:\n\n```sh\nruleName=\"textlint-rule-example\"\ngit clone --depth=1 https://github.com/textlint/textlint-rule-template-ts.git ${ruleName}\ncd ${ruleName}\n# Initialize git\nrm -rf .git/\nrm -rf .github/\ngit init\n# Initialize npm\nnpm init\nnpm install\n# Initialize README\n# Notice: force update exist README.md\n./node_modules/.bin/textlint-scripts init\n```\n\n## Usage\n\nSee [textlint-scripts](https://github.com/textlint/textlint-scripts \"textlint-scripts\") for more details.\n\n### Build\n\nBuilds source codes for publish to the `lib` folder.\nYou can write ES2015+ source codes in `src/` folder.\n\n    npm run build\n    \n### Tests\n\nRun test code in `test` folder.\nTest textlint rule by [textlint-tester](https://github.com/textlint/textlint-tester \"textlint-tester\"). \n\n    npm test\n\n### Publish\n\nPublish your rule to [npm](https://www.npmjs.com/). \n\n    # Update version and git tag `patch` or `minor` or `major`\n    npm version {patch|minor|major}\n    npm publish\n\n## How to write textlint rule?\n\nSee documentation.\n\n- [Creating Rules · textlint](https://textlint.github.io/docs/rule.html)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-rule-template-ts","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextlint%2Ftextlint-rule-template-ts","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Ftextlint-rule-template-ts/lists"}