{"id":15827786,"url":"https://github.com/wkillerud/semantic-release-publint","last_synced_at":"2025-03-15T04:31:15.989Z","repository":{"id":250201911,"uuid":"833779519","full_name":"wkillerud/semantic-release-publint","owner":"wkillerud","description":"Run publint as part of the verify step in semantic-release","archived":false,"fork":false,"pushed_at":"2024-10-01T10:20:00.000Z","size":249,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2024-10-12T10:29:55.797Z","etag":null,"topics":["publint","semantic-release","semantic-release-plugin"],"latest_commit_sha":null,"homepage":"https://www.npmjs.com/package/semantic-release-publint","language":"JavaScript","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/wkillerud.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,"publiccode":null,"codemeta":null}},"created_at":"2024-07-25T18:20:50.000Z","updated_at":"2024-10-01T10:20:02.000Z","dependencies_parsed_at":"2024-07-25T21:26:53.669Z","dependency_job_id":"28e99fcc-7c59-4027-87e5-b7c7649fba09","html_url":"https://github.com/wkillerud/semantic-release-publint","commit_stats":{"total_commits":11,"total_committers":3,"mean_commits":"3.6666666666666665","dds":"0.36363636363636365","last_synced_commit":"c6556883e48d88b6fff403140bc66d87bf16a6ee"},"previous_names":["wkillerud/semantic-release-publint"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wkillerud%2Fsemantic-release-publint","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wkillerud%2Fsemantic-release-publint/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wkillerud%2Fsemantic-release-publint/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/wkillerud%2Fsemantic-release-publint/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/wkillerud","download_url":"https://codeload.github.com/wkillerud/semantic-release-publint/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243685506,"owners_count":20330980,"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":["publint","semantic-release","semantic-release-plugin"],"created_at":"2024-10-05T10:09:15.422Z","updated_at":"2025-03-15T04:31:15.720Z","avatar_url":"https://github.com/wkillerud.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Publint Semantic Release Plugin\n\nThis is a plugin for [semantic-release] that runs [publint] as part of the [Verify Conditions step], to help you catch packaging errors before publishing.\n\nBy default the plugin will log all lint messages, but only fail verification if there are messages at the `error` level. You can turn on `strict` mode, which treats any `warning` as errors as well.\n\n## Usage\n\n```sh\nnpm install --save-dev semantic-release-publint\n```\n\n```js\n// release.config.mjs\n/**\n * @type {Partial\u003cimport('semantic-release').GlobalConfig\u003e}\n */\nexport default {\n\tplugins: [\n\t\t\"@semantic-release/commit-analyzer\",\n\t\t\"@semantic-release/release-notes-generator\",\n\t\t[\n\t\t\t\"@semantic-release/npm\",\n\t\t\t{\n\t\t\t\ttarballDir: \"release\",\n\t\t\t},\n\t\t],\n\t\t[\n\t\t\t\"semantic-release-publint\",\n\t\t\t{\n\t\t\t\tstrict: true, // optional, to treat warnings as errors\n\t\t\t},\n\t\t],\n\t\t[\n\t\t\t\"@semantic-release/github\",\n\t\t\t{\n\t\t\t\tassets: \"release/*.tgz\",\n\t\t\t},\n\t\t],\n\t],\n\tbranches: [\"main\"],\n};\n```\n\n## Options\n\nThe config is passed to [publint].\n\n```js\n{\n  /**\n   * Path to your package that contains a package.json file.\n   * Defaults to `process.cwd()`.\n   */\n  pkgDir: './path/to/package',\n  /**\n   * The level of messages to log (default: `'suggestion'`).\n   * - `suggestion`: logs all messages\n   * - `warning`: logs only `warning` and `error` messages\n   * - `error`: logs only `error` messages\n   */\n  level: 'warning',\n  /**\n   * Report warnings as errors (default: `false`)\n   */\n  strict: true\n}\n```\n\n## Rules\n\nSee the [publint documentation] for an explanation of the different rules and messages.\n\n[semantic-release]: https://github.com/semantic-release\n[publint]: https://github.com/bluwy/publint\n[Verify Conditions step]: https://github.com/semantic-release/semantic-release?tab=readme-ov-file#release-steps\n[publint documentation]: https://publint.dev/rules\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwkillerud%2Fsemantic-release-publint","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fwkillerud%2Fsemantic-release-publint","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fwkillerud%2Fsemantic-release-publint/lists"}