Setting up docs

.gitattributes

@@ -0,0 +1 @@
+pnpm-lock.yaml -diff

packages/little-router/src/plugin.ts

@@ -14,13 +14,15 @@ export type PluginContext<
   readonly params: Record<string, string>;
   /**
    * This is only used for adding typing hints to requests
-   * @private */
+   *
+   * @private
+   */
   readonly __hint?: HINT;
 };
 /**
- * _hint is for giving hints to the consumer making the request
- * regarding the request init and any possible search params
- * */
+ * _hint is for giving hints to the consumer making the request regarding the
+ * request init and any possible search params
+ */
 export type Plugin<REST_ARGS extends unknown[] = unknown[]> = (
   { request, url, params }: PluginContext<any>,
   ...rest: REST_ARGS

packages/little-router/src/router.ts

@@ -3,6 +3,30 @@ import { HasOverlap } from "./overlap.js";
 import { Plugin, PluginContext } from "./plugin.js";
 import { FetchDefinition, Queries } from "./fetch.js";
 
+/**
+ * Returns an instance of RouteBuilder that you can use to build your routing
+ * structure.
+ *
+ * @typeParam REST_ARGS - Used to type Env and ExecutionContext from cloudflare
+ *                        workers. More info in [cloudflare workers docs]( https://developers.cloudflare.com/workers/platform/environment-variables/).
+ *
+ * The returned RouteBuilder can be build upon by using the method function,
+ * with names corresponding to http request methods.
+ *
+ * {@link Method | Availible Methods}
+ *
+ * @example
+ * ```ts
+ * type Env = {
+ *   MY_ENV_VAR: string;
+ *   MY_SECRET: string;
+ *   myKVNamespace: KVNamespace;
+ * };
+ * const router = Router<Env, ExecutionContext>
+ * ```
+ *
+ * More on cloudflare worker types in [their documentation](https://github.com/cloudflare/workerd/tree/main/npm/workers-types#using-bindings).
+ */
 export const Router = <REST_ARGS extends unknown[] = []>(): RouteBuilder<
   REST_ARGS,
   never

tools/config/.eslintrc.cjs

@@ -2,9 +2,10 @@
 module.exports = {
   extends: ["eslint:recommended", "plugin:@typescript-eslint/recommended"],
   parser: "@typescript-eslint/parser",
-  plugins: ["@typescript-eslint"],
+  plugins: ["@typescript-eslint", "eslint-plugin-tsdoc"],
   root: true,
   rules: {
+    "tsdoc/syntax": "warn",
     "@typescript-eslint/no-unused-vars": ["error", { argsIgnorePattern: "^_" }],
     "@typescript-eslint/no-explicit-any": "off",
   },

tools/config/package.json

@@ -15,13 +15,15 @@
     "@typescript-eslint/eslint-plugin": "^5.59.7",
     "@typescript-eslint/parser": "^5.59.7",
     "eslint": "^8.41.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^2.8.8",
     "typescript": "^5.0.4"
   },
   "peerDependencies": {
     "@typescript-eslint/eslint-plugin": "^5.59.1",
     "@typescript-eslint/parser": "^5.59.1",
     "eslint": "^8.39.0",
+    "eslint-plugin-tsdoc": "^0.2.17",
     "prettier": "^2.8.8",
     "typescript": "^5.0.4"
   }