feat: prepare for public

Author: Handfish

.changeset/config.json

@@ -6,5 +6,6 @@
   "linked": [],
   "access": "public",
   "updateInternalDependencies": "patch",
-  "ignore": ["@acme/docs"]
+  "baseBranch": "main",
+  "ignore": ["@ajel/docs", "@ajel/benchmarks"]
 }

.github/workflows/docs.yml

@@ -0,0 +1,88 @@
+# Sample workflow for building and deploying a Next.js site to GitHub Pages
+#
+# To get started with Next.js see: https://nextjs.org/docs/getting-started
+#
+name: Deploy Next.js site to Pages
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["main"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  # Build job
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+
+      - name: Setup pnpm 7
+        uses: pnpm/action-setup@v2
+        with:
+          version: 7
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: "20"
+          cache: ${{ steps.detect-package-manager.outputs.manager }}
+
+      - name: Setup Pages
+        uses: actions/configure-pages@v4
+        with:
+          # Automatically inject basePath in your Next.js configuration file and disable
+          # server side image optimization (https://nextjs.org/docs/api-reference/next/image#unoptimized).
+          #
+          # You may remove this line if you want to manage the configuration yourself.
+          static_site_generator: next
+
+      - name: Restore cache
+        uses: actions/cache@v3
+        with:
+          path: |
+            .next/cache
+          # Generate a new cache whenever packages or source files change.
+          key: ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.json') }}-${{ hashFiles('**.[jt]s', '**.[jt]sx') }}
+          # If source files changed but packages didn't, rebuild from a prior cache.
+          restore-keys: |
+            ${{ runner.os }}-nextjs-${{ hashFiles('**/pnpm-lock.json') }}-
+
+      - name: Install Dependencies
+        run: pnpm i
+
+      - name: Build with Next.js
+        working-directory: apps/docs
+        run: pnpm build
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: apps/docs/out
+
+  # Deployment job
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.github/workflows/release.nopeyml

@@ -0,0 +1,44 @@
+# name: Release
+
+# on:
+#   push:
+#     branches:
+#       - main
+
+# concurrency: ${{ github.workflow }}-${{ github.ref }}
+
+# jobs:
+#   release:
+#     name: Release
+#     runs-on: ubuntu-latest
+#     steps:
+#       - name: Checkout Repo
+#         uses: actions/checkout@v2
+
+#       - name: Setup pnpm 7
+#         uses: pnpm/action-setup@v2
+#         with:
+#           version: 7
+
+#       - name: Setup Node.js 18.x
+#         uses: actions/setup-node@v2
+#         with:
+#           node-version: 18.x
+
+#       - name: Install Dependencies
+#         run: pnpm i
+
+#       - name: Create Release Pull Request or Publish to npm
+#         id: changesets
+#         uses: changesets/action@v1
+#         with:
+#           # This expects you to have a script called release which does a build for your packages and calls changeset publish
+#           publish: pnpm release
+#         env:
+#           GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+#           NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+#       - name: Send a Slack notification if a publish happens
+#         if: steps.changesets.outputs.published == 'true'
+#         # You can do something when a publish happens.
+#         run: my-slack-bot send-notification --message "A new version of ${GITHUB_REPOSITORY} was published!"

.github/workflows/release.yml

@@ -1,73 +1,78 @@
-# Turborepo Design System starter with Changesets
+<p align="center"><a href="https://github.com/Handfish/ajel" target="_blank"><img src="https://raw.githubusercontent.com/Handfish/ajel/main/apps/docs/public/ajel2.svg" width="100" alt="Laravel Logo"></a></p>
 
-This is an official React design system starter powered by Turborepo. Versioning and package publishing is handled by [Changesets](https://github.com/changesets/changesets) and fully automated with GitHub Actions.
+<p align="center">Ajel is a <b>312 byte</b> set of functions that encourage you to handle errors in a way that is similar to Golang.</p>
 
-## Using this example
+<p align="center">
+<a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/v/ajel.svg" alt="NPM Version" /></a>
+<a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/l/ajel.svg" alt="Package License" /></a>
+<a href="https://www.npmjs.com/ajel" target="_blank"><img src="https://img.shields.io/npm/dt/ajel.svg" alt="NPM Downloads" /></a>
+<a href="https://handfish.github.io/ajel" target="_blank"><img src="https://img.shields.io/badge/GitHub%20Pages-222222?style=for-the-badge&logo=GitHub%20Pages&logoColor=white" /></a>
+<a href="https://github.com/Handfish/ajel" target="_blank"><img src="https://img.shields.io/badge/GitHub-100000?style=for-the-badge&logo=github&logoColor=white" /></a>
+</p>
 
-Run the following command:
 
-```sh
-npx create-turbo@latest -e with-changesets
-```
-
-## What's inside?
-
-This Turborepo includes the following:
-
-### Apps and Packages
-
-- `docs`: A placeholder documentation site powered by [Next.js](https://nextjs.org/)
-- `@ajel/core`: core React components
-- `@ajel/utils`: shared React utilities
-- `@ajel/tsconfig`: shared `tsconfig.json`s used throughout the monorepo
-- `@ajel/eslint-config`: ESLint preset
 
-Each package and app is 100% [TypeScript](https://www.typescriptlang.org/).
+# [ajel](https://handfish.github.io/ajel)
 
-### Utilities
+### Installation
 
-This Turborepo has some additional tools already setup for you:
+`yarn add ajel eslint-plugin-ajel`
 
-- [TypeScript](https://www.typescriptlang.org/) for static type checking
-- [ESLint](https://eslint.org/) for code linting
-- [Prettier](https://prettier.io) for code formatting
+`pnpm add ajel eslint-plugin-ajel`
 
-### Useful commands
 
-- `yarn build` - Build all packages and the docs site
-- `yarn dev` - Develop all packages and the docs site
-- `yarn lint` - Lint all packages
-- `yarn changeset` - Generate a changeset
-- `yarn clean` - Clean up all `node_modules` and `dist` folders (runs each package's clean script)
+### Example usage
+```typescript
+// Handling async functions that throw
+import { ajel } from 'ajel';
 
-### Changing the npm organization scope
+async function main() {
+  const [result, err] = await ajel(Promise.resolve('hello world'));
 
-The npm organization scope for this design system starter is `@ajel`. To change this, it's a bit manual at the moment, but you'll need to do the following:
+  if (err) {
+    return err;
+  }
 
-- Rename folders in `packages/*` to replace `ajel` with your desired scope
-- Search and replace `ajel` with your desired scope
-- Re-run `yarn install`
+  return result;
+}
+```
 
-## Versioning and Publishing packages
+```typescript
+// Handling synchronous functions that throw
+import { sjel } from 'ajel';
 
-Package publishing has been configured using [Changesets](https://github.com/changesets/changesets). Please review their [documentation](https://github.com/changesets/changesets#documentation) to familiarize yourself with the workflow.
+function main() {
+  const [result, err] = sjel(JSON.parse)("{}");
 
-This example comes with automated npm releases setup in a [GitHub Action](https://github.com/changesets/action). To get this working, you will need to create an `NPM_TOKEN` and `GITHUB_TOKEN` in your repository settings. You should also install the [Changesets bot](https://github.com/apps/changeset-bot) on your GitHub repository as well.
+  if (err) {
+    return err;
+  }
 
-For more information about this automation, refer to the official [changesets documentation](https://github.com/changesets/changesets/blob/main/docs/automating-changesets.md)
+  return result;
+}
+```
 
-### npm
+`ajel` and `sjel` are a set of functions that return a tuple representing a potential result and a potential error.
+On success, the result item has value. On error, the error item has value. It's that simple.
 
-If you want to publish package to the public npm registry and make them publicly available, this is already setup.
+More interestingly, it comes with a series of linting tools to help enforce the paradigm available in the package `eslint-plugin-ajel`
 
-To publish packages to a private npm organization scope, **remove** the following from each of the `package.json`'s
+### Basic eslintrc
 
-```diff
-- "publishConfig": {
--  "access": "public"
-- },
+```javascript
+{
+  plugins: ['ajel'],
+  extends: [
+    'plugin:ajel/recommended',
+  ],
+}
 ```
 
-### GitHub Package Registry
+### What's inside this repo?
 
-See [Working with the npm registry](https://docs.github.com/en/packages/working-with-a-github-packages-registry/working-with-the-npm-registry#publishing-a-package-using-publishconfig-in-the-packagejson-file)
+#### Apps and Packages
+
+- `docs`: A placeholder documentation site powered by [Next.js](https://nextjs.org/)
+- `ajel`: The core library (function)
+- `eslint-plugin-ajel`: Eslint rules for proper usage and error handling paradigm
+- `benchmarks`: Testing ajel's performance against other methods

README.md

@@ -1,6 +1,6 @@
 module.exports = {
   root: true,
-  extends: ["@acme/eslint-config/next.js"],
+  extends: ["@ajel/eslint-config/next.js"],
   parser: "@typescript-eslint/parser",
   parserOptions: {
     project: true,

apps/docs/.eslintrc.js renamed to apps/docs/.eslintrc.cjs

@@ -0,0 +1 @@
+out

apps/docs/.gitignore

@@ -9,4 +9,10 @@ const withNextra = nextra({
   themeConfig: './theme.config.jsx'
 })
 
-export default withNextra()
+export default withNextra({
+  output: "export",
+  images: {
+    unoptimized: true
+  },
+  basePath: '/ajel',
+})

apps/docs/next.config.js

@@ -11,7 +11,8 @@
     "clean": "rm -rf .turbo && rm -rf node_modules && rm -rf .next"
   },
   "dependencies": {
-    "@ajel/core": "workspace:*",
+    "@next/eslint-plugin-next": "^14.0.4",
+    "ajel": "workspace:*",
     "next": "^14.0.4",
     "nextra": "^2.13.2",
     "nextra-theme-blog": "^2.13.2",

apps/docs/package.json

@@ -1,3 +1,5 @@
+// import Image from "next/image";
+
 export default function NavLogo() {
   return (
     <div
@@ -8,9 +10,8 @@ export default function NavLogo() {
         fontSize: "32px",
       }}
     >
-      {/* TODO: figure out how to size Logo and use that here instead */}
       <img
-        src="/ajel2.svg"
+        src="/ajel/ajel2.svg"
         style={{ height: "calc(var(--nextra-navbar-height) - 35px)" }}
         alt="ajel logo"
       />

apps/docs/src/components/NavLogo.tsx

@@ -0,0 +1,15 @@
+import { Html, Head, Main, NextScript } from 'next/document'
+
+export default function Document() {
+  return (
+    <Html lang="en">
+      <Head>
+        <link rel="shortcut icon" href="/ajel/favicon.ico" />
+      </Head>
+      <body>
+        <Main />
+        <NextScript />
+      </body>
+    </Html>
+  )
+}