{"id":26105324,"url":"https://github.com/stdlib-js/string-acronym","last_synced_at":"2025-04-12T18:26:19.145Z","repository":{"id":41359364,"uuid":"406438982","full_name":"stdlib-js/string-acronym","owner":"stdlib-js","description":"Generate an acronym for a given string.","archived":false,"fork":false,"pushed_at":"2024-12-23T02:56:21.000Z","size":1650,"stargazers_count":4,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"main","last_synced_at":"2025-03-26T12:46:49.367Z","etag":null,"topics":["abbr","abbreviate","abbreviation","acronym","javascript","node","node-js","nodejs","short","stdlib","str","string","util","utilities","utility","utils"],"latest_commit_sha":null,"homepage":"https://github.com/stdlib-js/stdlib","language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stdlib-js.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"CITATION.cff","codeowners":null,"security":"SECURITY.md","support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null},"funding":{"github":["stdlib-js"],"open_collective":"stdlib","tidelift":"npm/@stdlib/stdlib"}},"created_at":"2021-09-14T16:14:06.000Z","updated_at":"2024-12-23T02:15:01.000Z","dependencies_parsed_at":"2024-01-23T21:41:37.997Z","dependency_job_id":"d1f4af85-1006-4e5e-b826-7e8c33de20f6","html_url":"https://github.com/stdlib-js/string-acronym","commit_stats":{"total_commits":59,"total_committers":2,"mean_commits":29.5,"dds":"0.13559322033898302","last_synced_commit":"448231ed68bdb2233d6b2b5033154e1b848eb828"},"previous_names":[],"tags_count":28,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstring-acronym","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstring-acronym/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstring-acronym/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stdlib-js%2Fstring-acronym/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stdlib-js","download_url":"https://codeload.github.com/stdlib-js/string-acronym/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248477103,"owners_count":21110436,"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":["abbr","abbreviate","abbreviation","acronym","javascript","node","node-js","nodejs","short","stdlib","str","string","util","utilities","utility","utils"],"created_at":"2025-03-09T21:05:24.368Z","updated_at":"2025-04-12T18:26:19.119Z","avatar_url":"https://github.com/stdlib-js.png","language":"JavaScript","funding_links":["https://github.com/sponsors/stdlib-js","https://opencollective.com/stdlib","https://tidelift.com/funding/github/npm/@stdlib/stdlib"],"categories":[],"sub_categories":[],"readme":"\u003c!--\n\n@license Apache-2.0\n\nCopyright (c) 2021 The Stdlib Authors.\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n   http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n\n--\u003e\n\n\n\u003cdetails\u003e\n  \u003csummary\u003e\n    About stdlib...\n  \u003c/summary\u003e\n  \u003cp\u003eWe believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.\u003c/p\u003e\n  \u003cp\u003eThe library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.\u003c/p\u003e\n  \u003cp\u003eWhen you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.\u003c/p\u003e\n  \u003cp\u003eTo join us in bringing numerical computing to the web, get started by checking us out on \u003ca href=\"https://github.com/stdlib-js/stdlib\"\u003eGitHub\u003c/a\u003e, and please consider \u003ca href=\"https://opencollective.com/stdlib\"\u003efinancially supporting stdlib\u003c/a\u003e. We greatly appreciate your continued support!\u003c/p\u003e\n\u003c/details\u003e\n\n# acronym\n\n[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] \u003c!-- [![dependencies][dependencies-image]][dependencies-url] --\u003e\n\n\u003e Generate an acronym for a given string.\n\n\u003c!-- Section to include introductory text. Make sure to keep an empty line after the intro `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"intro\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.intro --\u003e\n\n\u003c!-- Package usage documentation. --\u003e\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\n```bash\nnpm install @stdlib/string-acronym\n```\n\nAlternatively,\n\n-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).\n-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).\n-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).\n-   To use as a general utility for the command line, install the corresponding [CLI package][cli-section] globally.\n\nThe [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.\n\nTo view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.\n\n\u003c/section\u003e\n\n\u003csection class=\"usage\"\u003e\n\n## Usage\n\n```javascript\nvar acronym = require( '@stdlib/string-acronym' );\n```\n\n#### acronym( str\\[, options] )\n\nGenerates an acronym for a given string.\n\n```javascript\nvar out = acronym( 'the quick brown fox' );\n// returns 'QBF'\n\nout = acronym( 'Hard-boiled eggs' );\n// returns 'HBE'\n```\n\nThe function accepts the following `options`:\n\n-   **stopwords**: list of custom stop words. If not specified, the function uses a default set of stop words from the English language that were deemed words one would likely want to exclude from the acronym generation (a subset of the stop words from [@stdlib/datasets/stopwords-en][@stdlib/datasets/stopwords-en]).\n\nBy default, the function uses a list of common English stop words. To use a custom list, set the `stopwords` option.\n\n```javascript\nvar out = acronym( 'the quick brown fox', {\n    'stopwords': []\n});\n// returns 'TQBF'\n\nout = acronym( 'the quick brown fox', {\n    'stopwords': [ 'the', 'quick', 'brown', 'fox' ]\n});\n// returns ''\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- Package usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- Package usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n## Examples\n\n\u003c!-- eslint no-undef: \"error\" --\u003e\n\n```javascript\nvar acronym = require( '@stdlib/string-acronym' );\n\nvar str = 'Test-driven development';\nvar out = acronym( str );\n// returns 'TDD'\n\nstr = 'Industrial Business Machines';\nout = acronym( str );\n// returns 'IBM'\n\nstr = 'National Aeronautics and Space Administration';\nout = acronym( str );\n// returns 'NASA'\n\nstr = 'To be determined...';\nout = acronym( str, {\n    'stopwords': []\n});\n// returns 'TBD'\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c!-- Section for describing a command-line interface. --\u003e\n\n* * *\n\n\u003csection class=\"cli\"\u003e\n\n## CLI\n\n\u003csection class=\"installation\"\u003e\n\n## Installation\n\nTo use as a general utility, install the CLI package globally\n\n```bash\nnpm install -g @stdlib/string-acronym-cli\n```\n\n\u003c/section\u003e\n\u003c!-- CLI usage documentation. --\u003e\n\n\n\u003csection class=\"usage\"\u003e\n\n### Usage\n\n```text\nUsage: acronym [options] [\u003cstring\u003e]\n\nOptions:\n\n  -h,    --help                Print this message.\n  -V,    --version             Print the package version.\n         --stopwords str       Comma-separated list of custom stop words.\n         --split sep           Delimiter for stdin data. Default: '/\\\\r?\\\\n/'.\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.usage --\u003e\n\n\u003c!-- CLI usage notes. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"notes\"\u003e\n\n### Notes\n\n-   If the split separator is a [regular expression][mdn-regexp], ensure that the `split` option is either properly escaped or enclosed in quotes.\n\n    ```bash\n    # Not escaped...\n    $ echo -n $'quick brown fox\\nAlpha-Centauri' | acronym --split /\\r?\\n/\n\n    # Escaped...\n    $ echo -n $'quick brown fox\\nAlpha-Centauri' | acronym --split /\\\\r?\\\\n/\n    ```\n\n-   The implementation ignores trailing delimiters.\n\n\u003c/section\u003e\n\n\u003c!-- /.notes --\u003e\n\n\u003c!-- CLI usage examples. --\u003e\n\n\u003csection class=\"examples\"\u003e\n\n### Examples\n\n```bash\n$ acronym 'the quick brown fox'\nQBF\n```\n\nTo use as a [standard stream][standard-streams],\n\n```bash\n$ echo -n 'the quick brown fox'' | acronym\nQBF\n```\n\nBy default, when used as a [standard stream][standard-streams], the implementation assumes newline-delimited data. To specify an alternative delimiter, set the `split` option.\n\n```bash\n$ echo -n 'quick brown fox\\tAlpha-Centauri' | acronym --split '\\t'\nQBF\nAC\n```\n\n\u003c/section\u003e\n\n\u003c!-- /.examples --\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.cli --\u003e\n\n\u003c!-- Section to include cited references. If references are included, add a horizontal rule *before* the section. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"references\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.references --\u003e\n\n\u003c!-- Section for related `stdlib` packages. Do not manually edit this section, as it is automatically populated. --\u003e\n\n\u003csection class=\"related\"\u003e\n\n\u003c/section\u003e\n\n\u003c!-- /.related --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\n\u003csection class=\"main-repo\" \u003e\n\n* * *\n\n## Notice\n\nThis package is part of [stdlib][stdlib], a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.\n\nFor more information on the project, filing bug reports and feature requests, and guidance on how to develop [stdlib][stdlib], see the main project [repository][stdlib].\n\n#### Community\n\n[![Chat][chat-image]][chat-url]\n\n---\n\n## License\n\nSee [LICENSE][stdlib-license].\n\n\n## Copyright\n\nCopyright \u0026copy; 2016-2024. The Stdlib [Authors][stdlib-authors].\n\n\u003c/section\u003e\n\n\u003c!-- /.stdlib --\u003e\n\n\u003c!-- Section for all links. Make sure to keep an empty line after the `section` element and another before the `/section` close. --\u003e\n\n\u003csection class=\"links\"\u003e\n\n[npm-image]: http://img.shields.io/npm/v/@stdlib/string-acronym.svg\n[npm-url]: https://npmjs.org/package/@stdlib/string-acronym\n\n[test-image]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml/badge.svg?branch=main\n[test-url]: https://github.com/stdlib-js/string-acronym/actions/workflows/test.yml?query=branch:main\n\n[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/string-acronym/main.svg\n[coverage-url]: https://codecov.io/github/stdlib-js/string-acronym?branch=main\n\n\u003c!--\n\n[dependencies-image]: https://img.shields.io/david/stdlib-js/string-acronym.svg\n[dependencies-url]: https://david-dm.org/stdlib-js/string-acronym/main\n\n--\u003e\n\n[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg\n[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im\n\n[stdlib]: https://github.com/stdlib-js/stdlib\n\n[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors\n\n[cli-section]: https://github.com/stdlib-js/string-acronym#cli\n[cli-url]: https://github.com/stdlib-js/string-acronym/tree/cli\n[@stdlib/string-acronym]: https://github.com/stdlib-js/string-acronym/tree/main\n\n[umd]: https://github.com/umdjs/umd\n[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules\n\n[deno-url]: https://github.com/stdlib-js/string-acronym/tree/deno\n[deno-readme]: https://github.com/stdlib-js/string-acronym/blob/deno/README.md\n[umd-url]: https://github.com/stdlib-js/string-acronym/tree/umd\n[umd-readme]: https://github.com/stdlib-js/string-acronym/blob/umd/README.md\n[esm-url]: https://github.com/stdlib-js/string-acronym/tree/esm\n[esm-readme]: https://github.com/stdlib-js/string-acronym/blob/esm/README.md\n[branches-url]: https://github.com/stdlib-js/string-acronym/blob/main/branches.md\n\n[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/string-acronym/main/LICENSE\n\n[standard-streams]: https://en.wikipedia.org/wiki/Standard_streams\n\n[mdn-regexp]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Regular_Expressions\n\n[@stdlib/datasets/stopwords-en]: https://github.com/stdlib-js/datasets-stopwords-en\n\n\u003c/section\u003e\n\n\u003c!-- /.links --\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstring-acronym","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstdlib-js%2Fstring-acronym","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstdlib-js%2Fstring-acronym/lists"}