feat: wip for adonis 6

LICENSE.md

@@ -1,6 +1,6 @@
 # The MIT License
 
-Copyright 2023 Xavier Stouder, contributors
+Copyright (c) 2023
 
 Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the 'Software'), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
 

README.md

@@ -1,48 +1,115 @@
-<div align="center">
-  <img src="https://user-images.githubusercontent.com/2575182/236930626-40d7d2a8-2ded-4f72-a9e8-d8f4ce43ec79.png" />
-  <h3>@stouder-io/adonis-geolite2</h3>
-  <p>Maxmind's GeoLite2 integration for Adonis</p>
-  <a href="https://www.npmjs.com/package/@stouder-io/adonis-geolite2">
-    <img src="https://img.shields.io/npm/v/@stouder-io/adonis-geolite2.svg?style=for-the-badge&logo=npm" />
-  </a>
-  <img src="https://img.shields.io/npm/l/@stouder-io/adonis-geolite2?color=blueviolet&style=for-the-badge" />
-  <img alt="npm" src="https://img.shields.io/npm/dt/@stouder-io/adonis-geolite2?style=for-the-badge">
-</div>
-
-## Legal Warning
-This package uses [geolite2-redist](https://www.npmjs.com/package/geolite2-redist) and thus, you MUST comply with it specifics conditions. For more informations please check their [npm page](https://www.npmjs.com/package/geolite2-redist#user-content-legal-warning).
-
-## Installation
-This package is available in the npm registry.
-```
-npm i @stouder-io/adonis-geolite2
-```
+# AdonisJS package starter kit
+
+> A boilerplate for creating AdonisJS packages
+
+This 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.
+
+## Setup
+
+- Clone the repo on your computer, or use `giget` to download this repo without the Git history.
+  ```sh
+  npx giget@latest gh:adonisjs/pkg-starter-kit
+  ```
+- Install dependencies.
+- Update the `package.json` file and define the `name`, `description`, `keywords`, and `author` properties.
+- The repo is configured with an MIT license. Feel free to change that if you are not publishing under the MIT license.
+
+## Folder structure
+
+The starter kit mimics the folder structure of the official packages. Feel free to rename files and folders as per your requirements.
 
-Next, configure the package by running the following command.
 ```
-node ace configure @stouder-io/adonis-geolite2
+├── providers
+├── src
+├── bin
+├── stubs
+├── configure.ts
+├── index.ts
+├── LICENSE.md
+├── package.json
+├── README.md
+├── tsconfig.json
+├── tsnode.esm.js
 ```
 
-## Usage
-The geolite2 is automatically attached to HTTP requests, allowing you to use it to retries informations about the geolocation of requesting IPs.
-```ts
-Route.get('/', async ({ geolite2 }: HttpContextContract) => {
-    const country = geolite2.country()
-    const city = geolite2.city()
-    const asn = geolite2.asn()
+- The `configure.ts` file exports the `configure` hook to configure the package using the `node ace configure` command.
+- The `index.ts` file is the main entry point of the package.
+- The `tsnode.esm.js` file runs TypeScript code using TS-Node + SWC. Please read the code comment in this file to learn more.
+- The `bin` directory contains the entry point file to run Japa tests.
+- Learn more about [the `providers` directory](./providers/README.md).
+- Learn more about [the `src` directory](./src/README.md).
+- Learn more about [the `stubs` directory](./stubs/README.md).
+
+### File system naming convention
+
+We 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.
+
+## Peer dependencies
+
+The 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.
+
+If your package needs Lucid to be functional, you may install `@adonisjs/lucid` as a development dependency and add it to the list of `peerDependencies`.
+
+As a rule of thumb, packages installed in the user application should be part of the `peerDependencies` of your package and not the main dependency.
+
+For 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).
+
+## Published files
+
+Instead of publishing your repo's source code to npm, you must cherry-pick files and folders to publish only the required files.
 
-    return { country, city, asn }
-})
+The cherry-picking uses the `files` property inside the `package.json` file. By default, we publish the following files and folders.
+
+```json
+{
+  "files": ["build/src", "build/providers", "build/stubs", "build/index.d.ts", "build/index.js"]
+}
 ```
 
-If no parameter is provided to the functions, it uses [`request.ip()`](https://docs.adonisjs.com/guides/request#request-ip-address). Alternatively you can pass the IP you want to lookup.
+If you create additional folders or files, mention them inside the `files` array.
+
+## Exports
 
-```ts
-Route.get('/', async ({ geolite2 }: HttpContextContract) => {
-    const country = geolite2.country('8.8.8.8')
-    const city = geolite2.city('8.8.8.8')
-    const asn = geolite2.asn('8.8.8.8')
+[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.
 
-    return { country, city, asn }
-})
+```json
+{
+  "exports": {
+    ".": "./build/index.js",
+    "./types": "./build/src/types.js"
+  }
+}
 ```
+
+- The dot `.` export is the main export.
+- The `./types` exports all the types defined inside the `./build/src/types.js` file (the compiled output).
+
+Feel free to change the exports as per your requirements.
+
+## Testing
+
+We 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.
+
+- `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).
+- `npm run quick:test`: Runs only the tests without linting or coverage reporting.
+
+The 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.
+
+## TypeScript workflow
+
+- The starter kit uses [tsc](https://www.typescriptlang.org/docs/handbook/compiler-options.html) for compiling the TypeScript to JavaScript when publishing the package.
+- [TS-Node](https://typestrong.org/ts-node/) and [SWC](https://swc.rs/) are used to run tests without compiling the source code.
+- 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.
+- You can perform type checking without compiling the source code using the `npm run type check` script.
+
+Feel free to explore the `tsconfig.json` file for all the configured options.
+
+## ESLint and Prettier setup
+
+The 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.
+
+## Using Stale bot
+
+The [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.
+
+Feel free to delete the `.github/stale.yml` and `.github/lock.yml` files if you decide not to use the Stale bot.

bin/test.ts

@@ -0,0 +1,11 @@
+import { assert } from '@japa/assert'
+import { configure, processCLIArgs, run } from '@japa/runner'
+
+processCLIArgs(process.argv.splice(2))
+
+configure({
+  files: ['tests/**/*.spec.ts'],
+  plugins: [assert()],
+})
+
+run()

configure.ts

@@ -0,0 +1,8 @@
+import ConfigureCommand from '@adonisjs/core/commands/configure'
+import { stubsRoot } from './stubs/main.js'
+
+export async function configure(command: ConfigureCommand) {
+  const codemods = await command.createCodemods()
+
+  await codemods.makeUsingStub(stubsRoot, 'config.stub', {})
+}

index.ts

@@ -0,0 +1,10 @@
+/*
+|--------------------------------------------------------------------------
+| Package entrypoint
+|--------------------------------------------------------------------------
+|
+| Export values from the package entrypoint as you see fit.
+|
+*/
+
+export { configure } from './configure.js'