{"_id":"@amphore-dev/architect-atomic-structure","name":"@amphore-dev/architect-atomic-structure","dist-tags":{"latest":"1.0.0"},"versions":{"1.0.0":{"name":"@amphore-dev/architect-atomic-structure","version":"1.0.0","description":"Atomic structure plugin for Architect CLI","repository":{"type":"git","url":"git+https://github.com/amphore-dev/architect-atomic-structure.git"},"main":"dist/index.js","scripts":{"build":"tsc"},"keywords":["architect","plugin","cli","atomic","structure","design","pattern"],"author":{"name":"Amphore Dev","email":"contact@amphore.dev"},"license":"ISC","_id":"@amphore-dev/architect-atomic-structure@1.0.0","gitHead":"0dddd0ed334aad96054c29c9693becff3adf67a1","types":"./dist/index.d.ts","bugs":{"url":"https://github.com/amphore-dev/architect-atomic-structure/issues"},"homepage":"https://github.com/amphore-dev/architect-atomic-structure#readme","_nodeVersion":"20.17.0","_npmVersion":"10.8.2","dist":{"integrity":"sha512-P8q4E24UGXvd6wBbwNGaFTMSfBLqZYDpEo5OA1gn4zahMTr4WEbDtO88Got+4/Jov1hWLiTEwyKqIspsbYLBqA==","shasum":"c69ce8e837c74163c8e0674e9d73b22cee4ce75c","tarball":"https://registry.npmjs.org/@amphore-dev/architect-atomic-structure/-/architect-atomic-structure-1.0.0.tgz","fileCount":7,"unpackedSize":8776,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQDpakZq0g/rjhSo/REyvg2DWdBWmppeZxNJF2y4s0/o+wIhANiAYkXrokiUsX7AgwhLtWhi1QCdV+lesO81XR8HdWUC"}]},"_npmUser":{"name":"shimon42","email":"contact@amphore.dev"},"directories":{},"maintainers":[{"name":"shimon42","email":"contact@amphore.dev"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/architect-atomic-structure_1.0.0_1727003983706_0.3503624566089618"},"_hasShrinkwrap":false}},"time":{"created":"2024-09-22T11:19:43.625Z","1.0.0":"2024-09-22T11:19:43.968Z","modified":"2024-09-22T11:19:44.224Z"},"maintainers":[{"name":"shimon42","email":"contact@amphore.dev"}],"description":"Atomic structure plugin for Architect CLI","homepage":"https://github.com/amphore-dev/architect-atomic-structure#readme","keywords":["architect","plugin","cli","atomic","structure","design","pattern"],"repository":{"type":"git","url":"git+https://github.com/amphore-dev/architect-atomic-structure.git"},"author":{"name":"Amphore Dev","email":"contact@amphore.dev"},"bugs":{"url":"https://github.com/amphore-dev/architect-atomic-structure/issues"},"license":"ISC","readme":"# Architect plugin: Atomic Structure\n\nThe **architect-atomic-structure** plugin extends the [Architect CLI tool](https://www.npmjs.com/package/@amphore-dev/architect) to help developers structure their projects using the atomic design methodology. This plugin provides a clear and scalable structure for components, pages, utilities, constants, types, hooks, and services, promoting consistency and maintainability across projects.\n\n## Features\n\n-   Follows the atomic design principle with support for Atoms, Molecules, Organisms, and Templates.\n-   Organizes pages, utilities, constants, types, hooks, and services into their own directories.\n-   Automatic generation of index files and sub-index files for easy imports.\n-   Customizable directory and naming conventions, including prefixes, suffixes, and case formats.\n-   Seamless integration with the Architect CLI for efficient project scaffolding.\n\n## Atomic Structure Breakdown\n\n| Name      | Type       | Out folder name | Description                                           |\n| --------- | ---------- | --------------- | ----------------------------------------------------- |\n| Atoms     | `atom`     | atoms           | Basic building blocks like buttons or form fields.    |\n| Molecules | `molecule` | molecules       | Groups of atoms that form more complex elements.      |\n| Organisms | `organism` | organisms       | Complex structures that combine multiple molecules.   |\n| Templates | `template` | templates       | Layout components that define the structure of pages. |\n| Pages     | `page`     | pages           | The highest level, representing full-page components. |\n| Utilities | `util`     | utils           | Helper functions and classes.                         |\n| Constants | `constant` | constants       | Constants like enums or configuration values.         |\n| Types     | `type`     | types           | Type definitions for TypeScript.                      |\n| Hooks     | `hook`     | hooks           | Custom React hooks.                                   |\n| Services  | `service`  | services        | API services or other external services.              |\n\n## Installation\n\nInstall the plugin in your project directory using npm or Yarn:\n\n```bash\nnpm install --save-dev @amphore-dev/architect-atomic-structure\n```\n\nor\n\n```bash\nyarn add --dev @amphore-dev/architect-atomic-structure\n```\n\n## Usage\n\nTo include the plugin, modify the `architect.config.json` file in your project directory.\n\n```json\n{\n    \"plugins\": [\"@amphore-dev/architect-atomic-structure\"],\n    \"outputDir\": \"src\"\n}\n```\n\nTo avoid conficlts with other plugins, don't forget to add the plugin to the `plugins` array AFTER all other plugins.\n\n## License\n\nThis plugin is licensed under the ISC License.\n","readmeFilename":"README.md"}