-
-
Notifications
You must be signed in to change notification settings - Fork 0
refactor(*): create src/types.js
#174
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 #174 +/- ##
=======================================
Coverage 98.54% 98.54%
=======================================
Files 4 4
Lines 275 275
=======================================
Hits 271 271
Misses 4 4 Continue to review full report in Codecov by Sentry.
|
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.
PR Overview
This PR introduces a new file defining common types used in the codebase, along with TypeScript checking enabled via JSDoc comments.
- Created file "src/types.js" that includes type definitions for a URI and its type.
- Added an overview comment and enabled TypeScript checking with "@ts-check".
- Established a typedef for a UriTypeObject that bundles the Uri and its Type.
Reviewed Changes
| File | Description |
|---|---|
| src/types.js | Defines common types and typedefs using JSDoc, and sets up exports. |
Copilot reviewed 1 out of 1 changed files in this pull request and generated no comments.
Comments suppressed due to low confidence (1)
src/types.js:29
- The module.exports is currently empty, so none of the type definitions are directly exportable. Consider exporting the types you defined if they are intended for use by other files, or document that these definitions are solely for type checking purposes.
module.exports = {};
…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 introduces a new file
src/types.jsto define common types used within the codebase. The changes include adding type definitions and ensuring type checking with TypeScript.Key changes:
src/types.jsto describe the purpose of the file.@ts-checkcomment.Uritype as a string and aTypetype as either'link'or'image'.UriTypeObjecttypedef that includes propertiesuriof typeUriandtypeof typeType.