Migrate YAML-based Regex Rules to CommonJS Modules #215
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This commit introduces a new utility script that converts YAML regex files to CommonJS modules. The script recursively processes all YAML files in the regexes directory and generates corresponding .js files with the same structure. This is a preparatory step for removing the filesystem dependency in the main package, making it more suitable for various JavaScript environments.
This commit transforms the regexes detection rules from YAML to CommonJS format as part of the ongoing effort to remove filesystem dependencies. The conversion maintains all existing regex patterns and device detection logic while making the rules more suitable for direct consumption in JavaScript environments.
This commit completes the migration from YAML to CommonJS modules by removing all YAML file loading logic and replacing it with direct requires. The changes include removing the base regex directory path constant, collection map caching, and file loading methods from the abstract parser. All parser classes now directly require their respective CommonJS regex modules instead of loading YAML files at runtime.
shorwood
commented
Jan 29, 2025
Comment on lines
+106
to
+108
| if (/\.ya?ml$/.test(file) === false) { | ||
| return; | ||
| } |
There was a problem hiding this comment.
This is to avoid checking the new .js files.
shorwood
commented
Jan 29, 2025
Comment on lines
-21
to
-30
| static ready() { | ||
| return collection !== void 0; | ||
| } | ||
|
|
||
| static init() { | ||
| if (helper.hasFile(path)) { | ||
| collection = helper.loadYMLFile(path); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
No longer required as the collection is ready once this module is resolved.
shorwood
commented
Jan 29, 2025
Comment on lines
-42
to
-51
| static ready() { | ||
| return collection !== void 0; | ||
| } | ||
|
|
||
| static init() { | ||
| if (helper.hasFile(path)) { | ||
| collection = helper.loadYMLFile(path); | ||
| } | ||
| } | ||
|
|
There was a problem hiding this comment.
No longer required as the collection is ready once this module is resolved.
shorwood
commented
Jan 29, 2025
Comment on lines
-33
to
-61
| get collection() { | ||
| if (!this.hasLoadCollection()) { | ||
| return null; | ||
| } | ||
| return collectionMap[this.fixtureFile]; | ||
| } | ||
|
|
||
| hasLoadCollection() { | ||
| return collectionMap[this.fixtureFile] !== void 0 | ||
| } | ||
|
|
||
| /** | ||
| * load collection | ||
| */ | ||
| loadCollection() { | ||
| if (!this.hasLoadCollection()) { | ||
| collectionMap[this.fixtureFile] = this.loadYMLFile(this.fixtureFile); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * load yaml file | ||
| * @param {string} file | ||
| * @returns {*} | ||
| */ | ||
| loadYMLFile(file) { | ||
| return helper.loadYMLFile(BASE_REGEXES_DIR + file); | ||
| } | ||
|
|
There was a problem hiding this comment.
No longer required as the collections are in memory.
Why?
|
|
Well, looked through all new code, everything's fine. Starting with version Thank you for contribution. |
sanchezzzhak
approved these changes
Feb 6, 2025
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Hello !
First, thank you for building and maintaining this library—it’s been a huge help. While bundling our application into a Docker container, We ran into issues because this library depends on the file system at runtime (YAML regexes). We patched it locally by converting everything to CommonJS modules, and I’m sharing that patch here in case others encounter the same problem.
Issue
pnpx esbuild ./index.js --bundle --platform=node > out.jsWorkaround
server.jsfile. This is an issue for us.pnpx esbuild ./index.js --bundle --platform=node --packages=external > out.jsSolution
node-device-detectorand its regex definitions can be bundled together in a single output without relying on the presence ofnode_modules.Considerations
requirestatements might raise overhead concerns, module resolution caches them by default, so performance impact should be minimal.Changes
.jsmodules.requirethese.jsmodules directly.Let me know what you think and thanks again for all your work on this project!