Skip to content

Refactor#17

Merged
gilbarbara merged 5 commits intomainfrom
refactor
Nov 23, 2025
Merged

Refactor#17
gilbarbara merged 5 commits intomainfrom
refactor

Conversation

@gilbarbara
Copy link
Copy Markdown
Owner

This pull request introduces several improvements and refactors to the codebase, focusing on the type-checking library's architecture, CI pipeline, and package configuration. The most significant changes include the migration from the legacy exports entry point to a new standalone export for tree-shakeable type checkers, updates to the CI workflow, and the addition of new type-checking functions. Documentation has also been updated to reflect these changes and provide clearer guidance for contributors.

Export and Package Architecture Refactor:

  • Migrated from the legacy exports entry point to a new standalone export, updating all references in package.json and replacing src/exports.ts with src/standalone.ts for individual checker functions. This improves tree-shaking and usage clarity. [1] [2] [3] [4] [5]
  • Updated devDependencies and build tools in package.json for improved compatibility and security, including newer versions of ESLint, Husky, TypeScript, and related tooling.
  • Updated bundle size constraints and build commands in package.json to enforce strict limits and reflect new entry points.

Continuous Integration and Tooling:

  • Renamed and refactored the CI workflow file from .github/workflows/main.yml to .github/workflows/ci.yml, modernizing syntax, updating action versions, and streamlining dependency installation and caching. [1] [2] [3]
  • Added a new eslint.config.mjs file using the latest ESLint config imports for consistency with updated tooling.

Type-Checking Library Enhancements:

  • Added new type-checking functions: is.class, is.integer, is.nonEmptyString, and is.url, expanding the library’s capabilities for runtime validation. [1] [2]
  • Updated internal helper types and arrays to support new object types (e.g., URL). [1] [2]

Documentation and Contributor Guidance:

  • Added CLAUDE.md with comprehensive guidance for contributors and AI code assistants, detailing project architecture, development commands, testing guidelines, and bundle size constraints.
  • Updated README.md to document new type-checkers, clarify usage of the new standalone export, fix typos, and improve API documentation. [1] [2] [3] [4] [5] [6] [7]

Codebase Cleanup:

  • Removed the obsolete src/exports.ts file as part of the migration to the new export strategy.

Let me know if you'd like to discuss any specific change or need help navigating the new export structure!

This comment was marked as outdated.

Repository owner deleted a comment from Copilot AI Nov 22, 2025
Repository owner deleted a comment from Copilot AI Nov 22, 2025
- rename to ci.yml
- update steps and versions

This comment was marked as outdated.

Repository owner deleted a comment from Copilot AI Nov 23, 2025
Repository owner deleted a comment from Copilot AI Nov 23, 2025
Repository owner deleted a comment from Copilot AI Nov 23, 2025
@sonarqubecloud
Copy link
Copy Markdown

@gilbarbara gilbarbara merged commit 21440bb into main Nov 23, 2025
4 checks passed
@gilbarbara gilbarbara deleted the refactor branch November 23, 2025 01:16
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants