{"id":19838139,"url":"https://github.com/textlint/editor-script-template","last_synced_at":"2025-02-28T18:50:27.376Z","repository":{"id":43330617,"uuid":"359146300","full_name":"textlint/editor-script-template","owner":"textlint","description":"@textlint/editor script template","archived":false,"fork":false,"pushed_at":"2025-01-08T15:07:55.000Z","size":447,"stargazers_count":10,"open_issues_count":1,"forks_count":13,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-01-11T11:17:01.767Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"https://textlint.github.io/editor-script-template/","language":null,"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":"2021-04-18T13:10:12.000Z","updated_at":"2024-08-18T04:30:58.000Z","dependencies_parsed_at":"2022-09-16T13:45:15.987Z","dependency_job_id":"a361cbbf-5cad-460c-97cc-4be57eb711c3","html_url":"https://github.com/textlint/editor-script-template","commit_stats":null,"previous_names":[],"tags_count":0,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Feditor-script-template","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Feditor-script-template/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Feditor-script-template/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/textlint%2Feditor-script-template/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/textlint","download_url":"https://codeload.github.com/textlint/editor-script-template/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241203161,"owners_count":19926731,"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":[],"created_at":"2024-11-12T12:16:53.003Z","updated_at":"2025-02-28T18:50:27.343Z","avatar_url":"https://github.com/textlint.png","language":null,"funding_links":[],"categories":[],"sub_categories":[],"readme":"# @textlint/editor-script-template\n\nThis template for [@textlint/editor](https://github.com/textlint/editor) worker scripts.\n\n## Setup\n\n1. Use this template → fork repository\n   - Repository name: your favorite name\n   - ✔ Include all branches\n2. Enable GitHub Pages on your repository's settings\n   - Source: Branch `gh-pages`\n\n![GitHub Pages Setting](./docs/gh-pages.png)\n\n3. Visit `https://{yourname}.github.io/{yourrepo}/` after adding rules \n\n## Add new rule\n\n    npm install textlint-rule-\u003cyou-want-to-add-rule\u003e\n    # edit .textlintrc.json and add it\n    git add .\n    git commit -m \"feat: add new rule\"\n\nAfter a commit, GitHub Actions publish your website to GitHub pages.\n\n## Test rule\n\n@textlint/editor script require browser supported textlint rule. So, Some textlint rule does not work on\n@textlint/editor.\n\nYou can test the rule on local.\n\n    npm run website -- --metadataName=\"your script name\" --metadataNamespace=\"https://github.com/your/repo\" --metadataHomepage=\"https://github.com/your/repo\"\n    npx http-serve dist/\n\nor add some metadata into `package.json`:\n\n```json5\n{\n  \"private\": true,\n  \"name\": \"@textlint/editor-script-template\",\n  // \u003c= edit your rule name\n  \"version\": \"1.0.0\",\n  \"homepage\": \"https://github.com/your/repo\",\n  // \u003c= add your repository url\n  \"description\": \"@textlint/editor script template\",\n  \"scripts\": {\n    \"website\": \"textlint-website-generator --outputDir dist\"\n  },\n  \"devDependencies\": {\n    \"@textlint/website-generator\": \"^0.10.0\"\n  },\n  \"dependencies\": {\n    \"textlint\": \"^11.9.0\",\n    \"textlint-filter-rule-comments\": \"^1.2.2\",\n    \"textlint-rule-no-todo\": \"^2.0.1\"\n  }\n}\n```\n\nAfter the setup, you can build and serve:\n\n    npm run website\n    npx http-serve dist/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Feditor-script-template","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftextlint%2Feditor-script-template","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftextlint%2Feditor-script-template/lists"}