{"id":21359558,"url":"https://github.com/suin/refractor-group-by-lines","last_synced_at":"2025-07-24T09:31:24.177Z","repository":{"id":57163453,"uuid":"373067295","full_name":"suin/refractor-group-by-lines","owner":"suin","description":"A utility to embed line information to Refractor ASTs","archived":false,"fork":false,"pushed_at":"2021-06-02T06:47:48.000Z","size":148,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-06-23T04:42:36.852Z","etag":null,"topics":["refractor"],"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/suin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-06-02T06:45:33.000Z","updated_at":"2021-06-02T06:49:36.000Z","dependencies_parsed_at":"2022-08-31T22:23:04.148Z","dependency_job_id":null,"html_url":"https://github.com/suin/refractor-group-by-lines","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/suin/refractor-group-by-lines","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suin%2Frefractor-group-by-lines","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suin%2Frefractor-group-by-lines/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suin%2Frefractor-group-by-lines/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suin%2Frefractor-group-by-lines/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/suin","download_url":"https://codeload.github.com/suin/refractor-group-by-lines/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/suin%2Frefractor-group-by-lines/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":266720551,"owners_count":23973995,"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","status":"online","status_checked_at":"2025-07-23T02:00:09.312Z","response_time":66,"last_error":null,"robots_txt_status":null,"robots_txt_updated_at":null,"robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["refractor"],"created_at":"2024-11-22T05:28:40.090Z","updated_at":"2025-07-24T09:31:23.903Z","avatar_url":"https://github.com/suin.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# @suin/refractor-group-by-lines\n\nA utility to embed line information to [Refractor](https://github.com/wooorm/refractor) ASTs.\n\n## Installation\n\n```bash\nyarn add @suin/refractor-group-by-lines\n# or\nnpm install @suin/refractor-group-by-lines\n```\n\n## Usage\n\n### Basic Usage\n\ncode.js:\n\n```js\n/* MULTIPLE\n   LINE\n   COMMENT */\n`MULTIPLE\n  LINE\n  STRING`;\nMany.Tokens.In.A.Single.Line;\n```\n\n```typescript\nimport refractor from \"refractor\";\nimport groupByLines from \"@suin/refractor-group-by-lines\";\n\nconst code = fs.readFileSync(\"./code.js\", \"utf-8\");\nconst tree = refractor.highlight(code, \"js\");\nconst newTree = groupByLines(tree);\n```\n\nThe structure of `tree` is:\n\n```\nroot[17]\n├─0 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"comment\"]}\n│   └─0 text \"/* MULTIPLE\\n   LINE\\n   COMMENT */\"\n├─1 text \"\\n\"\n├─2 element\u003cspan\u003e[3]\n│   │ properties: {\"className\":[\"token\",\"template-string\"]}\n│   ├─0 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"template-punctuation\",\"string\"]}\n│   │   └─0 text \"`\"\n│   ├─1 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"string\"]}\n│   │   └─0 text \"MULTIPLE\\n  LINE\\n  STRING\"\n│   └─2 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"template-punctuation\",\"string\"]}\n│       └─0 text \"`\"\n├─3 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \";\"\n├─4 text \"\\n\"\n├─5 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n│   └─0 text \"Many\"\n├─6 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \".\"\n├─7 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"property-access\"]}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n│       └─0 text \"Tokens\"\n├─8 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \".\"\n├─9 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"property-access\"]}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n│       └─0 text \"In\"\n├─10 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \".\"\n├─11 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"constant\"]}\n│   └─0 text \"A\"\n├─12 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \".\"\n├─13 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"property-access\"]}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n│       └─0 text \"Single\"\n├─14 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   └─0 text \".\"\n├─15 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"token\",\"property-access\"]}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n│       └─0 text \"Line\"\n└─16 element\u003cspan\u003e[1]\n    │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    └─0 text \";\"\n```\n\nThe structure of the `newTree` above becomes:\n\n```\nroot[7]\n├─0 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":1}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"comment\"]}\n│       └─0 text \"/* MULTIPLE\\n\"\n├─1 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":2}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"comment\"]}\n│       └─0 text \"   LINE\\n\"\n├─2 element\u003cspan\u003e[2]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":3}\n│   ├─0 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"comment\"]}\n│   │   └─0 text \"   COMMENT */\"\n│   └─1 text \"\\n\"\n├─3 element\u003cspan\u003e[2]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":4}\n│   ├─0 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"template-string\",\"template-punctuation\",\"string\"]}\n│   │   └─0 text \"`\"\n│   └─1 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"template-string\",\"string\"]}\n│       └─0 text \"MULTIPLE\\n\"\n├─4 element\u003cspan\u003e[1]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":5}\n│   └─0 element\u003cspan\u003e[1]\n│       │ properties: {\"className\":[\"token\",\"template-string\",\"string\"]}\n│       └─0 text \"  LINE\\n\"\n├─5 element\u003cspan\u003e[4]\n│   │ properties: {\"className\":[\"line\"],\"data-line-number\":6}\n│   ├─0 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"template-string\",\"string\"]}\n│   │   └─0 text \"  STRING\"\n│   ├─1 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"template-string\",\"template-punctuation\",\"string\"]}\n│   │   └─0 text \"`\"\n│   ├─2 element\u003cspan\u003e[1]\n│   │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n│   │   └─0 text \";\"\n│   └─3 text \"\\n\"\n└─6 element\u003cspan\u003e[12]\n    │ properties: {\"className\":[\"line\"],\"data-line-number\":7}\n    ├─0 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"maybe-class-name\"]}\n    │   └─0 text \"Many\"\n    ├─1 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    │   └─0 text \".\"\n    ├─2 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"property-access\",\"maybe-class-name\"]}\n    │   └─0 text \"Tokens\"\n    ├─3 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    │   └─0 text \".\"\n    ├─4 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"property-access\",\"maybe-class-name\"]}\n    │   └─0 text \"In\"\n    ├─5 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    │   └─0 text \".\"\n    ├─6 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"constant\"]}\n    │   └─0 text \"A\"\n    ├─7 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    │   └─0 text \".\"\n    ├─8 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"property-access\",\"maybe-class-name\"]}\n    │   └─0 text \"Single\"\n    ├─9 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"punctuation\"]}\n    │   └─0 text \".\"\n    ├─10 element\u003cspan\u003e[1]\n    │   │ properties: {\"className\":[\"token\",\"property-access\",\"maybe-class-name\"]}\n    │   └─0 text \"Line\"\n    └─11 element\u003cspan\u003e[1]\n        │ properties: {\"className\":[\"token\",\"punctuation\"]}\n        └─0 text \";\"\n```\n\nHTML would be like this:\n\n```html\n\u003cspan class=\"line\" data-line-number=\"1\"\n  \u003e\u003cspan class=\"token comment\"\u003e/* MULTIPLE\\n\u003c/span\u003e\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"2\"\n  \u003e\u003cspan class=\"token comment\"\u003e LINE\\n\u003c/span\u003e\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"3\"\n  \u003e\u003cspan class=\"token comment\"\u003e COMMENT */\u003c/span\u003e\\n\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"4\"\n  \u003e\u003cspan class=\"token template-string template-punctuation string\"\u003e`\u003c/span\n  \u003e\u003cspan class=\"token template-string string\"\u003eMULTIPLE\\n\u003c/span\u003e\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"5\"\n  \u003e\u003cspan class=\"token template-string string\"\u003e LINE\\n\u003c/span\u003e\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"6\"\n  \u003e\u003cspan class=\"token template-string string\"\u003e STRING\u003c/span\n  \u003e\u003cspan class=\"token template-string template-punctuation string\"\u003e`\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e;\u003c/span\u003e\\n\u003c/span\n\u003e\u003cspan class=\"line\" data-line-number=\"7\"\n  \u003e\u003cspan class=\"token maybe-class-name\"\u003eMany\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e.\u003c/span\n  \u003e\u003cspan class=\"token property-access maybe-class-name\"\u003eTokens\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e.\u003c/span\n  \u003e\u003cspan class=\"token property-access maybe-class-name\"\u003eIn\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e.\u003c/span\u003e\u003cspan class=\"token constant\"\u003eA\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e.\u003c/span\n  \u003e\u003cspan class=\"token property-access maybe-class-name\"\u003eSingle\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e.\u003c/span\n  \u003e\u003cspan class=\"token property-access maybe-class-name\"\u003eLine\u003c/span\n  \u003e\u003cspan class=\"token punctuation\"\u003e;\u003c/span\u003e\u003c/span\n\u003e\n```\n\n## API Reference\n\nhttps://suin.github.io/refractor-group-by-lines/\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuin%2Frefractor-group-by-lines","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsuin%2Frefractor-group-by-lines","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsuin%2Frefractor-group-by-lines/lists"}