{"id":16791994,"url":"https://github.com/metonym/template-posthtml-plugin","last_synced_at":"2025-03-17T02:14:06.156Z","repository":{"id":35821081,"uuid":"199105502","full_name":"metonym/template-posthtml-plugin","owner":"metonym","description":"Template for developing and publishing PostHTML plugins","archived":false,"fork":false,"pushed_at":"2023-01-04T21:55:47.000Z","size":1616,"stargazers_count":0,"open_issues_count":10,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-01-23T12:09:30.204Z","etag":null,"topics":["boilerplate","posthtml","posthtml-plugin","template","typescript"],"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/metonym.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":"2019-07-27T02:31:28.000Z","updated_at":"2020-03-30T13:55:34.000Z","dependencies_parsed_at":"2023-01-16T07:03:20.442Z","dependency_job_id":null,"html_url":"https://github.com/metonym/template-posthtml-plugin","commit_stats":null,"previous_names":[],"tags_count":4,"template":true,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Ftemplate-posthtml-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Ftemplate-posthtml-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Ftemplate-posthtml-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/metonym%2Ftemplate-posthtml-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/metonym","download_url":"https://codeload.github.com/metonym/template-posthtml-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243960666,"owners_count":20375105,"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":["boilerplate","posthtml","posthtml-plugin","template","typescript"],"created_at":"2024-10-13T08:43:47.697Z","updated_at":"2025-03-17T02:14:06.130Z","avatar_url":"https://github.com/metonym.png","language":"TypeScript","readme":"# template-posthtml-plugin \u003cimg align=\"right\" width=\"220\" height=\"200\" title=\"PostHTML logo\" src=\"http://posthtml.github.io/posthtml/logo.svg\"\u003e\n\n[![Build][build]][build-badge]\n[![Coverage][codecov-shield]][codecov]\n\n\u003e Template for developing and publishing PostHTML plugins.\n\nInspired by the [posthtml-plugin-boilerplate](https://github.com/posthtml/posthtml-plugin-boilerplate), this template is used to develop and build [PostHTML](https://github.com/posthtml) plugins with TypeScript.\n\nThe `posthtml-plugin-boilerplate` contains an excellent sample [README](https://github.com/posthtml/posthtml-plugin-boilerplate/blob/master/readme.md) to describe and document a plugin.\n\nDon't forget to update the [changelog](CHANGELOG.md) for each release published to the [npm registry](https://www.npmjs.com/).\n\n## Available Scripts\n\n### `yarn test:tdd`\n\nRuns all tests in [watch mode](https://jestjs.io/docs/en/cli#watch). Use this command when developing a plugin.\n\n### `yarn test`\n\nRuns [Jest](https://jestjs.io/) and [ts-jest](https://github.com/kulshekhar/ts-jest) and outputs testing coverage.\n\n### `yarn build`\n\nBuilds the plugin for production.\n\n## Continuous Integration (CI)\n\n[Travis CI](https://travis-ci.org/) is used to build and test pushed commits.\n\n```yaml\nlanguage: node_js\nnode_js: stable\ncache: yarn\nafter_success: npx codecov\n# Travis CI executes the `yarn test` script by default\n# Test coverage should be printed to the Travis build log\n```\n\nThe Travis CI configuration can be modified in [`.travis.yml`](.travis.yml).\n\n## Other tools\n\nLinters are run in [husky](https://github.com/typicode/husky) hooks to enforce a consistent code and formatting style:\n\n- **[Prettier](https://prettier.io/)**: opinionated code formatter used to lint staged files in the pre-commit husky hook\n\n- **[TSLint](https://github.com/palantir/tslint)**: extensible TypeScript linter used to lint (and fix) errors in the pre-commit husky hook\n\n- **[commitlint](https://github.com/conventional-changelog/commitlint)**: commit message linter used in the commit-msg husky hook to encourage [semantic commit messages](https://seesparkbox.com/foundry/semantic_commit_messages)\n\n## Publishing to npm\n\nWhen publishing your plugin for the first time, be sure to update the `homepage`, `repository` and `bugs` fields in the `package.json`. Login as your npm user and run the following:\n\n```bash\nyarn publish\n# OR\nnpm publish\n```\n\nUpdate the relevant publishing-related fields in [package.json](package.json).\n\n```json\n{\n  \"repository\": {\n    \"type\": \"git\",\n    \"url\": \"https://github.com/{USER}/template-posthtml-plugin.git\"\n  },\n  \"homepage\": \"https://github.com/{USER}/template-posthtml-plugin\",\n  \"keywords\": [\"posthtml\", \"posthtml plugin\", \"plugin\"],\n  \"bugs\": \"https://github.com/{USER}/template-posthtml-plugin/issues\"\n}\n```\n\n## License\n\n[MIT](LICENSE)\n\n[build]: https://travis-ci.com/metonym/template-posthtml-plugin.svg?branch=master\n[build-badge]: https://travis-ci.com/metonym/template-posthtml-plugin\n[codecov]: https://codecov.io/gh/metonym/template-posthtml-plugin\n[codecov-shield]: https://img.shields.io/codecov/c/github/metonym/template-posthtml-plugin.svg\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Ftemplate-posthtml-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmetonym%2Ftemplate-posthtml-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmetonym%2Ftemplate-posthtml-plugin/lists"}