{"id":18396412,"url":"https://github.com/fearlesssolutions/acronym_plugin","last_synced_at":"2025-06-30T09:36:34.329Z","repository":{"id":38051020,"uuid":"291748922","full_name":"FearlessSolutions/acronym_plugin","owner":"FearlessSolutions","description":null,"archived":false,"fork":false,"pushed_at":"2024-03-28T20:42:24.000Z","size":351,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-05T06:37:03.150Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FearlessSolutions.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"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}},"created_at":"2020-08-31T15:12:11.000Z","updated_at":"2022-06-10T19:03:35.000Z","dependencies_parsed_at":"2024-03-28T21:43:17.744Z","dependency_job_id":"06049cc0-143a-4542-935a-005727674f83","html_url":"https://github.com/FearlessSolutions/acronym_plugin","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FearlessSolutions%2Facronym_plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FearlessSolutions%2Facronym_plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FearlessSolutions%2Facronym_plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FearlessSolutions%2Facronym_plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FearlessSolutions","download_url":"https://codeload.github.com/FearlessSolutions/acronym_plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247595068,"owners_count":20963939,"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":[],"created_at":"2024-11-06T02:13:42.672Z","updated_at":"2025-04-07T04:32:41.945Z","avatar_url":"https://github.com/FearlessSolutions.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Fearless Acronym Extension\n\nThis extension adds an icon to the browser bar that, when clicked, displays a search dropdown. When users perform a search, full and partial matches are returned. Users select which acronym files are relevant to them via the extension options.\n\n![Acronym Search Box](./images/search-box.png)\n\n## Setup\n\n1. Clone or [download](https://github.com/FearlessSolutions/acronym_plugin/archive/master.zip) the acronym project\n\n`git clone https://github.com/FearlessSolutions/acronym_plugin.git`\n\n2. In Chrome, navigate to the Extentions page (Window \u003e Extensions).\n\n3. Verify that \"Developer mode\" is enabled.\n\n4. In the upper left, click the \"Load unpacked\" button.\n\n5. Select the directory with the acronym project. This will load the extension into your browser\n\n## Extension Options\n\n1. To select which acronyms are used in the extension, navigate to the Extentions page (Window \u003e Extensions)\n\n2. Click on \"Extension options\" and a pop-up will display\n\n3. Select the appropriate acronym sets for your use case\n\n![Acronym Extension Options](./images/extension-options.png)\n\n## Using the extension\n\n1. Click on the Fearless logo in the browser extension toolbar, a dropdown with an input box should display.\n\n2. Enter the acronym into the input box, the results will return full and partial matches.\n\n## Adding new acronym sets\n\nBefore adding new files, try to remove duplicates between the new project specific file and the baseline files (fearless.json and software.json).\n\n1. Add the JSON file to the `acronyms` project directory. Be sure to format it with consideration to the following information.\n\n   _Note that when there are multiple meanings for the same acronym, a new entry should be created_\n\n   `abbreviation` Acronym\n\n   `title` An individual meaning of the acronym\n\n   `description` (optional) in future functionality, it would be nice to have additional or contextual information to include\n\n   `category` (optional) in future functionality, it could be helpful to have more granular classification of the terms\n\nExample:\n\n```\n{\n    \"abbreviation\": \"TLA\",\n    \"title\": \"Three Letter Acronym\",\n    \"description\": \"This is a longer description of the TLA\"\n    \"category\": \"Base\"\n}\n```\n\n2. Update `base.js` by adding an entry referencing the new file\n\n   `ref` id used in the html of the Extension Options setting\n\n   `name` display name used to reference the acronym set in the Extension Options setting\n\n   `default` whether to always include the acroynym set in searches. This should more than likely be set to false.\n\n   `url` absolute URL for the JSON file\n\nExample:\n\n```\n{\n    ref: \"new-file\",\n    name: \"Display name\",\n    default: false,\n    url:\n      \"https://URL_TO_FILE/FILENAME.json\",\n}\n```\n\n3. Verify!\n\n   - File name displays in the list of Extension Options\n   - File can be selected and saved in the Extension Options\n   - Acronyms return in the search results when the file _is_ selected in the Extension Options\n   - Acronyms _do not_ return when the file _is not_ selected in the Extension Options\n\n# Testing\n\nChrome may give you a hard time about testing the new data sets on your local `base.js` if you try to change the paths to `file:///` prefixes or local machine paths. \n\nAn easy way to test on the fly if you have Node's `http-server` or installed is to call either one with the `--cors` parameter as shown below. Unfortunately Python's `http.server` does not appear to have added a simple CORS option.\n\n```\nc:\\Projects\\acronym_plugin\u003enpm install -g http-server\nc:\\Projects\\acronym_plugin\u003ehttp-server --cors ./\nStarting up http-server, serving ./\n\nhttp-server version: 14.1.1\n\nhttp-server settings:\nCORS: ./\nAvailable on:\n  http://127.0.0.1:8080\n```\n\nThen set the local path in a `base.js` option to be, for example, `http://127.0.0.1:8080/acronyms/cms.json`.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffearlesssolutions%2Facronym_plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffearlesssolutions%2Facronym_plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffearlesssolutions%2Facronym_plugin/lists"}