-
-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(*): restructure directories and update comments #191
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
|
Labels have been automatically applied based on the Conventional Commits specification.🏷️ |
Codecov ReportAll modified and coverable lines are covered by tests ✅
@@ Coverage Diff @@
## main #191 +/- ##
==========================================
+ Coverage 98.97% 99.60% +0.62%
==========================================
Files 7 11 +4
Lines 392 1016 +624
==========================================
+ Hits 388 1012 +624
Misses 4 4
Continue to review full report in Codecov by Sentry.
🚀 New features to boost your workflow:
|
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull Request Overview
This pull request refactors the codebase by restructuring utility directories, renaming files and functions for consistency, and updating tests to use modern Node.js testing modules. The key changes include:
- Renaming and relocating utility modules (e.g., get-definition-node-uri-type, get-uri-types)
- Enhancing test coverage with new test files and modern testing APIs
- Updating import paths and package scripts for consistency and maintainability
Reviewed Changes
Copilot reviewed 14 out of 14 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/utils/get-definition-node-uri-type/get-definition-node-uri-type.test.js | Added new tests for the get-definition-node-uri-type module |
| src/utils/get-uri-types/get-uri-types.test.js | Added new tests for the get-uri-types module |
| src/utils/get-uri-types/index.js | Created an index file for the get-uri-types module |
| src/utils/get-definition-node-uri-type/index.js | Created an index file for the get-definition-node-uri-type module |
| tests/textlint-rule-allowed-uris.test.js | Updated tests to use Node.js native testing and modernized require methods |
| src/utils/get-uri-types/get-uri-types.js | Refactored utility functions to update naming from getUriList* to getUriTypes* |
| src/utils/get-definition-node-uri-type/get-definition-node-uri-type.js | Updated theme import path and refined JSDoc comments for clarity |
| src/utils/uri-types/uri-types.test.js | Modified require path in tests to reflect new file structure |
| src/textlint-rule-allowed-uris.js | Updated import paths to use the new get-uri-types module |
| tests/utils/getUriList.test.js | Removed tests for the deprecated getUriList module |
| tests/utils/getDefinitionNodeUriType.test.js | Removed tests for the deprecated getDefinitionNodeUriType module |
…ch`) (#200) ## Release Information: `v1.0.9` New release of `lumirlumir/npm-textlint-rule-allowed-uris` has arrived! :tada: This PR bumps the package versions from `v1.0.8` to `v1.0.9` (`patch`). See [Actions](https://github.com/lumirlumir/npm-textlint-rule-allowed-uris/actions/runs/13927306027) for more details. | Info | Value | | ----------- | -------------------------- | | Repository | `lumirlumir/npm-textlint-rule-allowed-uris` | | SEMVER | `patch` | | Pre ID | `canary` | | Short SHA | f11ce22 | | Old Version | `v1.0.8` | | New Version | `v1.0.9` | <!-- Release notes generated using configuration in .github/release.yml at main --> ## What's Changed ### 🧰 Chores * chore(sync-server): update `dependabot.yml` by @lumirlumir in #167 * chore(*): add `provenance` to `publishConfig` in `package.json` by @lumirlumir in #169 * chore(sync-server): update `publish.yml` and `.prettierignore` by @lumirlumir in #171 * chore(sync-server): update `.editorconfig` `max_line_length` to `100000` by @lumirlumir in #181 * chore(sync-server): update `.markdownlint.json` by @lumirlumir in #186 * chore(*): install `textlint` as deps-dev and delete unnecessary files by @lumirlumir in #190 * chore(*): drop `mocha` and replace it with node built-in test runner by @lumirlumir in #192 * chore(*): create `CONTRIBUTING.md` and update ESLint config file by @lumirlumir in #194 * chore(*): add textlint configuration and integrate with lint-staged by @lumirlumir in #197 ### 🔄 Continuous Integrations * ci(sync-server): add permissions to read contents in `lint.yml` and `test.yml` workflows by @lumirlumir in #179 * ci(sync-server): add permissions to `pull-request.yml` and `sync-client.yml` by @lumirlumir in #180 * ci(*): drop `bump.yml` and create `version-multirepo.yml` by @lumirlumir in #198 * ci(*): create `release.yml` by @lumirlumir in #199 ### 📝 Documentation * docs(*): create `SECURITY.md` by @lumirlumir in #193 * docs(*): update `README.md` and `config.yml` by @lumirlumir in #195 ### ♻️ Code Refactoring * refactor(*): update module imports to use `node:` prefix for consistency by @lumirlumir in #173 * refactor(*): create `src/types.js` by @lumirlumir in #174 * refactor(*): rename `src/types.js` to `src/types/index.js` by @lumirlumir in #175 * refactor(*): restructure `theme` utilities and update usage in files by @lumirlumir in #176 * refactor(*): rename and refactor `UriTypes` class by @lumirlumir in #177 * refactor(*): restructure directories and update comments by @lumirlumir in #191 ### ⬆️ Dependency Updates * chore(deps-dev): bump eslint from 9.20.1 to 9.21.0 by @dependabot in #165 * chore(deps-dev): bump prettier from 3.5.1 to 3.5.2 by @dependabot in #166 * chore(deps): bump axios from 1.7.9 to 1.8.1 by @dependabot in #168 * chore(deps): bump undici from 6.19.7 to 6.21.1 in the npm_and_yarn group across 1 directory by @dependabot in #170 * chore(deps-dev): bump prettier from 3.5.2 to 3.5.3 by @dependabot in #172 * chore(deps-dev): bump eslint from 9.21.0 to 9.22.0 by @dependabot in #182 * chore(deps): bump axios from 1.8.1 to 1.8.2 by @dependabot in #183 * chore(deps-dev): bump @babel/core from 7.26.9 to 7.26.10 in the babel group across 1 directory by @dependabot in #184 * chore(deps-dev): bump textlint-tester from 14.4.2 to 14.5.0 by @dependabot in #185 * chore(deps-dev): bump eslint-config-bananass from 0.0.5 to 0.0.6 in the bananass group across 1 directory by @dependabot in #187 * chore(deps): bump axios from 1.8.2 to 1.8.3 by @dependabot in #188 * chore(deps-dev): bump lint-staged from 15.4.3 to 15.5.0 by @dependabot in #189 **Full Changelog**: v1.0.8...v1.0.9
This pull request includes several changes aimed at improving the codebase by renaming files for consistency, updating function names, and adding comprehensive tests. The most important changes include renaming utility files, updating test scripts, and enhancing the
textlint-rule-allowed-urisrule.File Renaming and Function Updates:
src/utils/getDefinitionNodeUriType.jstosrc/utils/get-definition-node-uri-type/get-definition-node-uri-type.jsand updated the import paths accordingly. [1] [2]src/utils/getUriList.jstosrc/utils/get-uri-types/get-uri-types.jsand updated the function names fromgetUriListtogetUriTypes. [1] [2] [3] [4]Test Enhancements:
src/utils/get-definition-node-uri-type/get-definition-node-uri-type.test.jsto test theget-definition-node-uri-typemodule.src/utils/get-uri-types/get-uri-types.test.jsto test theget-uri-typesmodule.textlint-rule-allowed-uristest file to include a detailed overview and use modern Node.js testing modules. [1] [2]Package Script Update:
testscript inpackage.jsonto include Node.js native testing withnode --test src.Code Consistency:
src/textlint-rule-allowed-uris.jsto use the newget-uri-typesmodule. [1] [2]These changes collectively enhance the maintainability, readability, and test coverage of the codebase.