Problem

The current package structure for @chez14/plong forces users to use deep, brittle import paths:

@import "~@chez14/plong/src/scss/theme";
@import "@chez14/plong/src/scss/variables";

This exposes the internal file structure (src/scss/...), making it difficult to refactor the internal organization without breaking user builds, and provides a poor developer experience.

Proposed Solution

1. Define exports in package.json: Implement the exports field in packages/plong/package.json to map clean entry points to the actual files.
   • Example mapping:

     "exports": {
       "./theme": "./src/scss/plong.scss",
       "./variables": "./src/scss/_variables.scss",
       "./mixins/*": "./src/scss/mixins/*.scss"
     }

2. Standardize Entry Points: Create a root index file if necessary to simplify imports further.

Benefits

• Encapsulation: Users only depend on the public API of the package, not its internal structure.
• Stability: Internal refactoring won't break downstream projects.
• Usability: Cleaner import syntax (@import "@chez14/plong/theme";).

Currently, the package READMEs contain placeholder/stock content, and the main repository README lacks references to the other packages in this monorepo.

Action Items

• Update packages/plong/README.md:
  • Replace stock content with proper documentation.
  • Include package name (@chez14/plong), description ("Plong theme for CHEZ14"), and clear installation/usage instructions.
• Update root README.md:
  • Add a section listing the packages in this monorepo (e.g., @chez14/plong, @chez14/react-components).
  • Ensure there are links to their respective directories or README files to improve discoverability.

This will significantly improve the usability and documentation standard of the packages within this repository.

Chris Qiang (5d9b7a1d) at 16 Mar 14:39

Chris Qiang (5d9b7a1d) at 16 Mar 14:35

Chris Qiang (867b5ea2) at 16 Mar 14:12

Chris Qiang (867b5ea2) at 16 Mar 14:11

Chris Qiang (ae8ea67a) at 16 Mar 14:08

Chris Qiang (6429d5bd) at 16 Mar 14:08

... and 1 more commit

Should fix #6.