{"_id":"@arthurfranckpat/adonis-unpoly","_rev":"2-3a6d0f4c0f4042c64860e467666dd1b5","name":"@arthurfranckpat/adonis-unpoly","dist-tags":{"latest":"0.0.3"},"versions":{"0.0.1":{"name":"@arthurfranckpat/adonis-unpoly","version":"0.0.1","keywords":[],"author":"","license":"MIT","_id":"@arthurfranckpat/adonis-unpoly@0.0.1","maintainers":[{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"}],"c8":{"exclude":["tests/**"],"reporter":["text","html"]},"np":{"tag":"latest","branch":"main","message":"chore(release): %s","anyBranch":false},"dist":{"shasum":"9abc2edef371ec4e4f784c12ed87e979de51951e","tarball":"https://registry.npmjs.org/@arthurfranckpat/adonis-unpoly/-/adonis-unpoly-0.0.1.tgz","fileCount":17,"integrity":"sha512-5uRUBcf+lhj8E5mfHvdWkcjeF+CJNDudww4cgSUeUiYpBxLySuVXGOsI5Uj2V90iQULiH5oJv6f5Tvfug8bylQ==","signatures":[{"sig":"MEUCIGcFIig5deQ9I52dMTAB6ioE28e/Z9FJb4ChRj61hDF8AiEAo3/RAZ8ugDaW0Hm6QwHRSWOtXwYnH4s3sTPdRsIGp2w=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23399},"type":"module","_from":"file:arthurfranckpat-adonis-unpoly-0.0.1.tgz","engines":{"node":">=20.6.0"},"exports":{".":"./build/index.js","./types":"./build/src/types.js","./unpoly_provider":"./build/providers/unpoly_provider.js","./unpoly_middleware":"./build/providers/unpoly_middleware.js"},"scripts":{"lint":"eslint . --ext=.ts","test":"c8 npm run quick:test","build":"tsc","clean":"del-cli build","format":"prettier --write .","pretest":"npm run lint","release":"np","version":"npm run build","prebuild":"npm run lint && npm run clean","postbuild":"npm run copy:templates","typecheck":"tsc --noEmit","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","copy:templates":"copyfiles \"stubs/**/*.stub\" build"},"_npmUser":{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"},"prettier":"@adonisjs/prettier-config","_resolved":"/private/var/folders/gq/tpsztgs96kgghthrsx0vlc2r0000gn/T/f82f30909dbaf8b891aea1757061bbb4/arthurfranckpat-adonis-unpoly-0.0.1.tgz","_integrity":"sha512-5uRUBcf+lhj8E5mfHvdWkcjeF+CJNDudww4cgSUeUiYpBxLySuVXGOsI5Uj2V90iQULiH5oJv6f5Tvfug8bylQ==","_npmVersion":"10.8.2","description":"An adapter of unpoly for adonis.js","directories":{},"_nodeVersion":"21.7.3","dependencies":{"@japa/file-system":"^2.3.0"},"eslintConfig":{"extends":"@adonisjs/eslint-config/package"},"publishConfig":{"tag":"latest","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"c8":"^10.1.2","np":"^10.0.6","eslint":"^8.57.0","del-cli":"^5.1.0","ts-node":"^10.9.2","prettier":"^3.3.2","ts-morph":"^23.0.0","@swc/core":"^1.6.3","copyfiles":"^2.4.1","typescript":"^5.4.5","@types/node":"^20.14.5","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@adonisjs/core":"^6.12.0","@adonisjs/tsconfig":"^1.3.0","@adonisjs/assembler":"^7.7.0","@adonisjs/eslint-config":"^1.3.0","@adonisjs/prettier-config":"^1.3.0"},"peerDependencies":{"@adonisjs/core":"^6.2.0","@adonisjs/session":"^7.4.2"},"_npmOperationalInternal":{"tmp":"tmp/adonis-unpoly_0.0.1_1724628981346_0.14077121408793425","host":"s3://npm-registry-packages"}},"0.0.2":{"name":"@arthurfranckpat/adonis-unpoly","version":"0.0.2","keywords":[],"author":"","license":"MIT","_id":"@arthurfranckpat/adonis-unpoly@0.0.2","maintainers":[{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"}],"c8":{"exclude":["tests/**"],"reporter":["text","html"]},"np":{"tag":"latest","branch":"main","message":"chore(release): %s","anyBranch":false},"dist":{"shasum":"e6a50b9220264c00460960b22c2869d97186d9bd","tarball":"https://registry.npmjs.org/@arthurfranckpat/adonis-unpoly/-/adonis-unpoly-0.0.2.tgz","fileCount":17,"integrity":"sha512-Y7eUCHC58f57hG94+B05AhkKC75+11J6REK+aUS5UKqHJxKX4hnZdVG0Il5zkp8XsklHxSY1sn+65DcIjkQNLg==","signatures":[{"sig":"MEUCIC/AwzRHBDyp5RzZ2RLvN45ue7Cqje6l/4/jxD0uIRgZAiEAnKf4DMOPPSAKheVbF6ymAloyXWTYB0G9YBi/DlbVtjg=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}],"unpackedSize":23365},"type":"module","_from":"file:arthurfranckpat-adonis-unpoly-0.0.2.tgz","engines":{"node":">=20.6.0"},"exports":{".":"./build/index.js","./types":"./build/src/types.js","./unpoly_provider":"./build/providers/unpoly_provider.js","./unpoly_middleware":"./build/providers/unpoly_middleware.js"},"scripts":{"lint":"eslint . --ext=.ts","test":"c8 npm run quick:test","build":"tsc","clean":"del-cli build","format":"prettier --write .","pretest":"npm run lint","release":"np","version":"npm run build","prebuild":"npm run lint && npm run clean","postbuild":"npm run copy:templates","typecheck":"tsc --noEmit","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","copy:templates":"copyfiles \"stubs/**/*.stub\" build"},"_npmUser":{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"},"prettier":"@adonisjs/prettier-config","_resolved":"/private/var/folders/gq/tpsztgs96kgghthrsx0vlc2r0000gn/T/1dd92a5c148bac631fda1b1172170d8e/arthurfranckpat-adonis-unpoly-0.0.2.tgz","_integrity":"sha512-Y7eUCHC58f57hG94+B05AhkKC75+11J6REK+aUS5UKqHJxKX4hnZdVG0Il5zkp8XsklHxSY1sn+65DcIjkQNLg==","_npmVersion":"10.8.2","description":"An adapter of unpoly for adonis.js","directories":{},"_nodeVersion":"21.7.3","dependencies":{"@japa/file-system":"^2.3.0"},"eslintConfig":{"extends":"@adonisjs/eslint-config/package"},"publishConfig":{"tag":"latest","access":"public"},"_hasShrinkwrap":false,"devDependencies":{"c8":"^10.1.2","np":"^10.0.6","eslint":"^8.57.0","del-cli":"^5.1.0","ts-node":"^10.9.2","prettier":"^3.3.2","ts-morph":"^23.0.0","@swc/core":"^1.6.3","copyfiles":"^2.4.1","typescript":"^5.4.5","@types/node":"^20.14.5","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@adonisjs/core":"^6.12.0","@adonisjs/tsconfig":"^1.3.0","@adonisjs/assembler":"^7.7.0","@adonisjs/eslint-config":"^1.3.0","@adonisjs/prettier-config":"^1.3.0"},"peerDependencies":{"@adonisjs/core":"^6.2.0","@adonisjs/session":"^7.4.2"},"_npmOperationalInternal":{"tmp":"tmp/adonis-unpoly_0.0.2_1724631493176_0.7379822298266128","host":"s3://npm-registry-packages"}},"0.0.3":{"name":"@arthurfranckpat/adonis-unpoly","description":"An adapter of unpoly for adonis.js","version":"0.0.3","engines":{"node":">=20.6.0"},"type":"module","exports":{".":"./build/index.js","./types":"./build/src/types.js","./unpoly_provider":"./build/providers/unpoly_provider.js","./unpoly_middleware":"./build/providers/unpoly_middleware.js"},"scripts":{"clean":"del-cli build","copy:templates":"copyfiles \"stubs/**/*.stub\" build","typecheck":"tsc --noEmit","lint":"eslint . --ext=.ts","format":"prettier --write .","quick:test":"node --import=./tsnode.esm.js --enable-source-maps bin/test.ts","pretest":"npm run lint","test":"c8 npm run quick:test","prebuild":"npm run lint && npm run clean","build":"tsc","postbuild":"npm run copy:templates","release":"np","version":"npm run build","prepublishOnly":"npm run build"},"devDependencies":{"@adonisjs/assembler":"^7.7.0","@adonisjs/core":"^6.12.0","@adonisjs/eslint-config":"^1.3.0","@adonisjs/prettier-config":"^1.3.0","@adonisjs/tsconfig":"^1.3.0","@japa/assert":"^3.0.0","@japa/runner":"^3.1.4","@swc/core":"^1.6.3","@types/node":"^20.14.5","c8":"^10.1.2","copyfiles":"^2.4.1","del-cli":"^5.1.0","eslint":"^8.57.0","np":"^10.0.6","prettier":"^3.3.2","ts-morph":"^23.0.0","ts-node":"^10.9.2","typescript":"^5.4.5"},"dependencies":{"@japa/file-system":"^2.3.0"},"peerDependencies":{"@adonisjs/core":"^6.2.0","@adonisjs/session":"^7.4.2"},"author":"","license":"MIT","keywords":[],"eslintConfig":{"extends":"@adonisjs/eslint-config/package"},"prettier":"@adonisjs/prettier-config","publishConfig":{"access":"public","tag":"latest"},"np":{"message":"chore(release): %s","tag":"latest","branch":"main","anyBranch":false},"c8":{"reporter":["text","html"],"exclude":["tests/**"]},"_id":"@arthurfranckpat/adonis-unpoly@0.0.3","gitHead":"9a7020555615fa41fb94ee55f5cd6addeab8935f","_nodeVersion":"20.11.0","_npmVersion":"10.7.0","dist":{"integrity":"sha512-m14rf6WzZ/ugNAlnnorpfMgQ/PqZiFXCxmQrEuboA66y4c9vK2bIoKPc5Z/dloconCGnKLhJJeE+WbUwocWwkQ==","shasum":"229e1e67f52f7f067c754a41c2382efd26b80bee","tarball":"https://registry.npmjs.org/@arthurfranckpat/adonis-unpoly/-/adonis-unpoly-0.0.3.tgz","fileCount":19,"unpackedSize":30467,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIBVXjfXMRoYDUJJp8H8HQ6CIxQNpbgD67L95eSzQuhI/AiBJYGFpKzexxNTqzNUuWKEUCZ6FilCoO4QU+z2jxq5r0A=="}]},"_npmUser":{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"},"directories":{},"maintainers":[{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/adonis-unpoly_0.0.3_1724763622991_0.1685068161861154"},"_hasShrinkwrap":false}},"time":{"created":"2024-08-25T23:36:21.268Z","modified":"2024-08-27T13:00:23.359Z","0.0.1":"2024-08-25T23:36:21.482Z","0.0.2":"2024-08-26T00:18:13.327Z","0.0.3":"2024-08-27T13:00:23.196Z"},"license":"MIT","keywords":[],"description":"An adapter of unpoly for adonis.js","maintainers":[{"name":"arthurfranckpat","email":"arthur.bledou@gmail.com"}],"readme":"# AdonisJS package starter kit\r\n\r\n> A boilerplate for creating AdonisJS packages\r\n\r\nThis repo provides you with a starting point for creating AdonisJS packages. Of course, you can create a package from scratch with your folder structure and workflow. However, using this starter kit can speed up the process, as you have fewer decisions to make.\r\n\r\n## Setup\r\n\r\n- Clone the repo on your computer, or use `giget` to download this repo without the Git history.\r\n  ```sh\r\n  npx giget@latest gh:adonisjs/pkg-starter-kit\r\n  ```\r\n- Install dependencies.\r\n- Update the `package.json` file and define the `name`, `description`, `keywords`, and `author` properties.\r\n- The repo is configured with an MIT license. Feel free to change that if you are not publishing under the MIT license.\r\n\r\n## Folder structure\r\n\r\nThe starter kit mimics the folder structure of the official packages. Feel free to rename files and folders as per your requirements.\r\n\r\n```\r\n├── providers\r\n├── src\r\n├── bin\r\n├── stubs\r\n├── configure.ts\r\n├── index.ts\r\n├── LICENSE.md\r\n├── package.json\r\n├── README.md\r\n├── tsconfig.json\r\n├── tsnode.esm.js\r\n```\r\n\r\n- The `configure.ts` file exports the `configure` hook to configure the package using the `node ace configure` command.\r\n- The `index.ts` file is the main entry point of the package.\r\n- The `tsnode.esm.js` file runs TypeScript code using TS-Node + SWC. Please read the code comment in this file to learn more.\r\n- The `bin` directory contains the entry point file to run Japa tests.\r\n- Learn more about [the `providers` directory](./providers/README.md).\r\n- Learn more about [the `src` directory](./src/README.md).\r\n- Learn more about [the `stubs` directory](./stubs/README.md).\r\n\r\n### File system naming convention\r\n\r\nWe use `snake_case` naming conventions for the file system. The rule is enforced using ESLint. However, turn off the rule and use your preferred naming conventions.\r\n\r\n## Peer dependencies\r\n\r\nThe starter kit has a peer dependency on `@adonisjs/core@6`. Since you are creating a package for AdonisJS, you must make it against a specific version of the framework core.\r\n\r\nIf your package needs Lucid to be functional, you may install `@adonisjs/lucid` as a development dependency and add it to the list of `peerDependencies`.\r\n\r\nAs a rule of thumb, packages installed in the user application should be part of the `peerDependencies` of your package and not the main dependency.\r\n\r\nFor example, if you install `@adonisjs/core` as a main dependency, then essentially, you are importing a separate copy of `@adonisjs/core` and not sharing the one from the user application. Here is a great article explaining [peer dependencies](https://blog.bitsrc.io/understanding-peer-dependencies-in-javascript-dbdb4ab5a7be).\r\n\r\n## Published files\r\n\r\nInstead of publishing your repo's source code to npm, you must cherry-pick files and folders to publish only the required files.\r\n\r\nThe cherry-picking uses the `files` property inside the `package.json` file. By default, we publish the following files and folders.\r\n\r\n```json\r\n{\r\n  \"files\": [\"build/src\", \"build/providers\", \"build/stubs\", \"build/index.d.ts\", \"build/index.js\"]\r\n}\r\n```\r\n\r\nIf you create additional folders or files, mention them inside the `files` array.\r\n\r\n## Exports\r\n\r\n[Node.js Subpath exports](https://nodejs.org/api/packages.html#subpath-exports) allows you to define the exports of your package regardless of the folder structure. This starter kit defines the following exports.\r\n\r\n```json\r\n{\r\n  \"exports\": {\r\n    \".\": \"./build/index.js\",\r\n    \"./types\": \"./build/src/types.js\"\r\n  }\r\n}\r\n```\r\n\r\n- The dot `.` export is the main export.\r\n- The `./types` exports all the types defined inside the `./build/src/types.js` file (the compiled output).\r\n\r\nFeel free to change the exports as per your requirements.\r\n\r\n## Testing\r\n\r\nWe configure the [Japa test runner](https://japa.dev/) with this starter kit. Japa is used in AdonisJS applications as well. Just run one of the following commands to execute tests.\r\n\r\n- `npm run test`: This command will first lint the code using ESlint and then run tests and report the test coverage using [c8](https://github.com/bcoe/c8).\r\n- `npm run quick:test`: Runs only the tests without linting or coverage reporting.\r\n\r\nThe starter kit also has a Github workflow file to run tests using Github Actions. The tests are executed against `Node.js 20.x` and `Node.js 21.x` versions on both Linux and Windows. Feel free to edit the workflow file in the `.github/workflows` directory.\r\n\r\n## TypeScript workflow\r\n\r\n- The starter kit uses [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) for compiling the TypeScript to JavaScript when publishing the package.\r\n- [TS-Node](https://typestrong.org/ts-node/) and [SWC](https://swc.rs/) are used to run tests without compiling the source code.\r\n- The `tsconfig.json` file is extended from [`@adonisjs/tsconfig`](https://github.com/adonisjs/tooling-config/tree/main/packages/typescript-config) and uses the `NodeNext` module system. Meaning the packages are written using ES modules.\r\n- You can perform type checking without compiling the source code using the `npm run type check` script.\r\n\r\nFeel free to explore the `tsconfig.json` file for all the configured options.\r\n\r\n## ESLint and Prettier setup\r\n\r\nThe starter kit configures ESLint and Prettier. Both configurations are stored within the `package.json` file and use our [shared config](https://github.com/adonisjs/tooling-config/tree/main/packages). Feel free to change the configuration, use custom plugins, or remove both tools altogether.\r\n\r\n## Using Stale bot\r\n\r\nThe [Stale bot](https://github.com/apps/stale) is a Github application that automatically marks issues and PRs as stale and closes after a specific duration of inactivity.\r\n\r\nFeel free to delete the `.github/stale.yml` and `.github/lock.yml` files if you decide not to use the Stale bot.\r\n","readmeFilename":"README.md"}