{"id":28957308,"url":"https://github.com/dictools/notifier","last_synced_at":"2026-05-09T19:31:44.172Z","repository":{"id":39609377,"uuid":"268908184","full_name":"dictools/notifier","owner":"dictools","description":"🌐 Dictools Notifier help the team to know when the dictionary keys have changed by a Slack notification","archived":false,"fork":false,"pushed_at":"2023-03-05T07:20:53.000Z","size":2301,"stargazers_count":0,"open_issues_count":8,"forks_count":0,"subscribers_count":0,"default_branch":"master","last_synced_at":"2025-08-29T18:33:57.002Z","etag":null,"topics":["dictionary-tools","dictools-notifier","git-hooks","husky","i18n","i18n-node","internationalization","json","slack","slack-webhook"],"latest_commit_sha":null,"homepage":"","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/dictools.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}},"created_at":"2020-06-02T21:04:20.000Z","updated_at":"2021-06-15T18:11:44.000Z","dependencies_parsed_at":"2023-02-06T01:31:36.615Z","dependency_job_id":null,"html_url":"https://github.com/dictools/notifier","commit_stats":null,"previous_names":[],"tags_count":3,"template":false,"template_full_name":null,"purl":"pkg:github/dictools/notifier","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dictools%2Fnotifier","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dictools%2Fnotifier/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dictools%2Fnotifier/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dictools%2Fnotifier/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dictools","download_url":"https://codeload.github.com/dictools/notifier/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dictools%2Fnotifier/sbom","scorecard":{"id":341103,"data":{"date":"2025-08-11","repo":{"name":"github.com/dictools/notifier","commit":"4eb5b726b69df43a5a7e4800f8f50afa54d2916b"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":1.7,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Code-Review","score":0,"reason":"Found 0/16 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Pinned-Dependencies","score":-1,"reason":"no dependencies found","details":null,"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Info: FSF or OSI recognized license: MIT License: LICENSE:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 4 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"60 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-968p-4wvh-cqc8","Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92","Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-cph5-m8f7-6c5x","Warn: Project is vulnerable to: GHSA-wf5p-g6vw-rhxx","Warn: Project is vulnerable to: GHSA-jr5f-v2jv-69x6","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-x9w5-v3q2-3rhw","Warn: Project is vulnerable to: GHSA-w8qv-6jwh-64r5","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-gxpj-cx7g-858c","Warn: Project is vulnerable to: GHSA-w573-4hg7-7wgq","Warn: Project is vulnerable to: GHSA-r9p9-mrjm-926w","Warn: Project is vulnerable to: GHSA-434g-2637-qmqr","Warn: Project is vulnerable to: GHSA-49q7-c7j4-3p7m","Warn: Project is vulnerable to: GHSA-977x-g7h5-7qgw","Warn: Project is vulnerable to: GHSA-f7q4-pwc6-w24p","Warn: Project is vulnerable to: GHSA-fc9h-whq2-v747","Warn: Project is vulnerable to: GHSA-vjh7-7g9h-fjfh","Warn: Project is vulnerable to: GHSA-74fj-2j2h-c42q","Warn: Project is vulnerable to: GHSA-pw2r-vq6v-hr8c","Warn: Project is vulnerable to: GHSA-jchw-25xp-jwwc","Warn: Project is vulnerable to: GHSA-cxjh-pqwp-8mfp","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-ww39-953v-wcq6","Warn: Project is vulnerable to: GHSA-43f8-2h32-f4cj","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-9c47-m6qq-7p4h","Warn: Project is vulnerable to: GHSA-76p3-8jx3-jpfq","Warn: Project is vulnerable to: GHSA-3rfm-jhwj-7488","Warn: Project is vulnerable to: GHSA-hhq3-ff78-jv3g","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-5fw9-fq32-wv5p","Warn: Project is vulnerable to: GHSA-hj48-42vr-x3v9","Warn: Project is vulnerable to: GHSA-h7cp-r72f-jxh6","Warn: Project is vulnerable to: GHSA-v62p-rq8g-8h59","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-44c6-4v22-4mhx","Warn: Project is vulnerable to: GHSA-4x5v-gmq8-25ch","Warn: Project is vulnerable to: GHSA-vx3p-948g-6vhq","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-4wf5-vphf-c2xc","Warn: Project is vulnerable to: GHSA-jgrx-mgxx-jf9v","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-j8xg-fqg3-53r7","Warn: Project is vulnerable to: GHSA-6fc8-4gx4-v693","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q","Warn: Project is vulnerable to: GHSA-c4w7-xm78-47vh"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T05:54:48.763Z","repository_id":39609377,"created_at":"2025-08-18T05:54:48.785Z","updated_at":"2025-08-18T05:54:48.785Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":32832867,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-08T08:22:46.396Z","status":"online","status_checked_at":"2026-05-09T02:00:06.633Z","response_time":123,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","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":["dictionary-tools","dictools-notifier","git-hooks","husky","i18n","i18n-node","internationalization","json","slack","slack-webhook"],"created_at":"2025-06-23T22:00:49.407Z","updated_at":"2026-05-09T19:31:44.155Z","avatar_url":"https://github.com/dictools.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/dictools/notifier\"\u003e\n    \u003cimg alt=\"Dictools Notifier\" src=\"./.github/dictools-notifier-logo@2x.png\" width=\"335\"\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n\u003cbr /\u003e\n\n\u003cp align=\"center\"\u003e\n  \u003ca href=\"https://github.com/dictools/notifier/blob/master/LICENSE\"\u003e\n    \u003cimg alt=\"MIT License\" src=\"https://img.shields.io/github/license/dictools/notifier?color=027EC5\u0026style=flat-square\"\n    /\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://www.npmjs.com/package/@dictools/notifier\"\u003e\n    \u003cimg alt=\"npm\" src=\"https://img.shields.io/npm/v/@dictools/notifier?style=flat-square\"\u003e\n  \u003c/a\u003e\n  \n  \u003ca href=\"https://circleci.com/gh/dictools/notifier\"\u003e\n    \u003cimg alt=\"CircleCI\" src=\"https://img.shields.io/circleci/build/github/dictools/notifier/master?style=flat-square\"\n    /\u003e\n  \u003c/a\u003e\n\n  \u003cbr /\u003e\n\n  \u003ca href='https://coveralls.io/github/dictools/notifier?branch=master'\u003e\n    \u003cimg alt=\"Coveralls Status\" src=\"https://img.shields.io/coveralls/github/dictools/notifier?style=flat-square\"\n    /\u003e\n  \u003c/a\u003e\n\n  \u003ca href=\"https://github.com/dictools/notifier#contributing\"\u003e\n    \u003cimg alt=\"PRs Welcome\" src=\"https://img.shields.io/badge/PRs-welcome-brightgreen?style=flat-square\"\n    /\u003e\n  \u003c/a\u003e\n\u003c/p\u003e\n\n## Getting started\nDictools Notifier is a tool used to notifies development/content team using a [slack webhook](https://api.slack.com/messaging/webhooks) based on a JSON file. Usually, it is used when the development team has the autonomy to create i18n dictionary keys directly in the code using a fallback file, this way it's not necessary to await the content team create the keys before writing the code.\n\n## Installation\nDictools Notifier can be installed using npm or yarn:\n\n```bash\n# npm\nnpm install @dictools/notifier --save-dev\n\n# yarn\nyarn add @dictools/notifier --dev\n```\n\n## Usage\n**Prerequisites:** \n- [Slack Incoming Webhooks](https://api.slack.com/messaging/webhooks)\n- [NodeJS](https://nodejs.org/) (\u003e=10.x.x) \n- [Git](https://git-scm.com/) (\u003e= 2.13.x)\n- Dictools Notifier should be used along with Git Hooks [ [post-commit](https://git-scm.com/docs/githooks#_post_commit) ] to recover information and compare your dictionary file. The library does not include built-in hooks, we recommend to use a third-party library like [husky](https://github.com/typicode/husky) or [build your own hooks](https://git-scm.com/book/en/v2/Customizing-Git-Git-Hooks)\n\n**Script Initializer**\n\nCreate a configuration file to start using `dictools/notifier`. The message can be formatted using the attachment format provided by slack, to know more details please check out the [documentation](https://api.slack.com/docs/messages/builder?msg=%7B%22attachments%22%3A%5B%7B%22fallback%22%3A%22Required%20plain-text%20summary%20of%20the%20attachment.%22%2C%22color%22%3A%22%2336a64f%22%2C%22pretext%22%3A%22Optional%20text%20that%20appears%20above%20the%20attachment%20block%22%2C%22author_name%22%3A%22Bobby%20Tables%22%2C%22author_link%22%3A%22http%3A%2F%2Fflickr.com%2Fbobby%2F%22%2C%22author_icon%22%3A%22http%3A%2F%2Fflickr.com%2Ficons%2Fbobby.jpg%22%2C%22title%22%3A%22Slack%20API%20Documentation%22%2C%22title_link%22%3A%22https%3A%2F%2Fapi.slack.com%2F%22%2C%22text%22%3A%22Optional%20text%20that%20appears%20within%20the%20attachment%22%2C%22fields%22%3A%5B%7B%22title%22%3A%22Priority%22%2C%22value%22%3A%22High%22%2C%22short%22%3Afalse%7D%5D%2C%22image_url%22%3A%22http%3A%2F%2Fmy-website.com%2Fpath%2Fto%2Fimage.jpg%22%2C%22thumb_url%22%3A%22http%3A%2F%2Fexample.com%2Fpath%2Fto%2Fthumb.png%22%2C%22footer%22%3A%22Slack%20API%22%2C%22footer_icon%22%3A%22https%3A%2F%2Fplatform.slack-edge.com%2Fimg%2Fdefault_application_icon.png%22%2C%22ts%22%3A123456789%7D%5D%7D).\n\n```js\n// notification.js\nconst Notifier = require(\"@dictools/notifier\");\n\nconst notification = new Notifier({\n  path: \"dictionary.json\", // JSON file only\n  hookUri: \"https://hooks.slack.com/services/\u003capi_token\u003e\",\n  channel: \"#acme-keys\", // Optional\n  username: \"Acme\", // Optional\n  project: {\n    name: \"Acme App\",\n    boardUrl: \"https://jira.acme.com/browse\",\n    key: \"ACM\" // (e.g. Task number ACM-0234)\n  }\n  /** \n   * Optional Configuration: ( Slack message replacement )\n   * Text has available replacement keys that is used to get information from the project or git diff\n   * and it can be customized as you need.\n   */\n  messages: {\n    /** \n     * Check out the available text keys\n     * @param {string} #{project} - Project name\n     * @param {string} #{key} - Dictionary key name\n     * @param {string} #{type} - Git change type (e.g. Added, Changed, Removed)\n     * @param {string} #{username} - Git committer name (Global or locally git username)\n     * @param {string} #{task} - Task link for the board (e.g. https://jira.acme.com/browse/ACM-0234)\n     * @param {string} #{value} - Current content key value\n     * @param {string} #{oldValue} - Previous content key value\n     */\n    title: \"Changes to #{project} dictionary key(s):\",\n    added: {\n      description: \"Dictionary key #{key} has been #{type}\",\n      body: \"Text: #{value}\",\n      footer: \"#{type} by: #{username} | Task: #{task}\"\n    },\n    changed: {\n      description: \"Dictionary key *#{key}* has been #{type}\",\n      body: \"From: #{oldValue} To: #{value}\",\n      footer: \"#{type} by: #{username} | Task: #{task}\"\n    },\n    removed: {\n      description: \"Dictionary key *#{key}* has been #{type}\",\n      body: \"Text: #{value}\",\n      footer: \"#{type} by: #{username} | Task: #{task}\"\n    }\n  }\n});\n\nnotification.init();\n```\n\n## Options\nOptions                        | Description                                                                                       | Types\n-------------------------------|---------------------------------------------------------------------------------------------------|-----------\npath                           | Defines the project's key map path                                                                | String\nhookUri                        | [Slack Webhooks](https://api.slack.com/messaging/webhooks) API url                                | String\nchannel (Optional)             | Slack channel where will be posted the notification                                               | String\nusername (Optional)            | Slack username that will be used to post the notification                                         | String\nproject.name                   | Project name                                                                                      | String\nproject.boardUrl               | It is used to link the notification with your project board `(e.g. https://jira.acme.com/browse)` | String\nproject.key                    | Key is the project identifier used to find a task number in a commit message `e.g. feat(blog): ACM-0234 :: add comment section`                                                                                                               | `String: \"ACM\"`/ `Array: [\"ACM\", \"AMC\"]` / `Regex: /(ACM)-[0-9]+/g`\nmessages.title                 | Slack message title `e.g. Changes to Acme dictionary key(s):`                                     | String\nmessages.added.description     | Slack message description to added keys `e.g. Dictionary key ticket_0234 has been added`          | String\nmessages.added.body            | Slack message body to added keys `e.g. Text: Hello World`                                         | String\nmessages.added.footer          | Slack message footer to added keys `e.g. Added by John Doe - Task: ACM-0234`                      | String\nmessages.changed.description   | Slack message description to changed keys `e.g. Dictionary key ticket_0234 has been changed`      | String\nmessages.changed.body          | Slack message body to changed keys `e.g. From: Hello World - To: Hi everyone!`                    | String\nmessages.changed.footer        | Slack message footer to changed keys `e.g. Changed by John Doe - Task: ACM-0234`                  | String\nmessages.removed.description   | Slack message description to removed keys `e.g. Dictionary key ticket_0234 has been removed`      | String\nmessages.removed.body          | Slack message body to removed keys `e.g. Text: Hi everyone!`                                      | String\nmessages.removed.footer        | Slack message footer to removed keys `e.g. Removed by John Doe - Task: ACM-0234`                  | String\n\n**Configure Git Hooks**\n\nLet's see an example using [Husky](https://github.com/typicode/husky).\n\n```js\n// package.json\n{\n  \"husky\": {\n    \"hooks\": {\n      \"post-commit\": \"node ./notification.js\"\n    }\n  }\n}\n```\nAfter setting up the hook start to commit normally and as soon as you have new changes to the dictionary you will receive a notification on the configured slack channel.\n\n**Slack message preview**\n\u003cp\u003e\n  \u003cimg alt=\"Dictools Notifier\" src=\"./.github/slack-message@2x.png\" width=\"600\"\u003e\n\u003c/p\u003e\n\n## Contributing\nThanks for being interested in helping us to improve the experience for who use this library, we are all ears to listen, if you want to collaborate reporting an issue, feature or something else please use the [issues](https://github.com/dictools/notifier/issues) section using the proper labels to your request, we will answer as soon as we can, thank you!\n\n## License\n\nDictools Notifier is [MIT licensed](/LICENSE).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdictools%2Fnotifier","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdictools%2Fnotifier","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdictools%2Fnotifier/lists"}