refactor(types): Enhance typings structure and module compatibility #5
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 change reorganizes and refactors the types declaration within the `types` module for better maintainability and future development. It includes restructuring the type definitions for specific API parameters. Additionally, the `types` module is now re-exported in the main package entry (`index.ts`), and the `declaration` option is enabled in the 'tsconfig.production.json' file. These changes enable the LSFND package to be correctly imported and used in TypeScript projects with the `module` set to `node16`, `nodenext`, `es5`, `esnext`, and others, in addition to `commonjs`, which was supported in previous release.
Added the `lsTypes` module to be minified after get transpiled from TypeScript. Other changes is unrelated changes.
mitsuki31
added
enhancement
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.
Overview
This pull request introduces several improvements and refinements to the
lsfndpackage. The focus is primarily on enhancing the types declaration within thetypesmodule, making it more organized and adaptable for future development and make this project supports in TypeScript projects with various modules settings. Additionally, it includes optimizations in the build process to minify thelsTypesmodule (forgot to include this module while maintaining #1).Notable Changes
Types Declaration Refactoring (6756665):
typesmodule for improved maintainability and future development.typesmodule in the main package entry (index.ts).declarationoption in thetsconfig.production.jsonfile to ensure proper TypeScript typings generation and it's crucial for compatibility in TypeScript project with various modules type, especially fornode*modules.lsfndpackage to be correctly imported and used in TypeScript projects with various module settings, includingnode16,nodenext,es5,esnext, and others, in addition tocommonjs, which was supported in the previous release.Build Process Improvement (4d48e06):
lsTypesmodule to be minified after transpilation from TypeScript during the build process.Summary
These changes significantly improve the organization and maintainability of the
typesmodule within thelsfndpackage. By refactoring type declarations and enabling re-exporting, the package is now compatible with a wider range of TypeScript module settings. Additionally, the build process has been enhanced by including thelsTypesmodule in the minification step, ensuring a more efficient production build.