Initial commit

Author: thedanchez

.github/CODEOWNERS

@@ -0,0 +1 @@
+thedanchez

.github/workflows/ci.yaml

@@ -0,0 +1,27 @@
+name: CI
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_dispatch:
+
+jobs:
+  quality-checks:
+    name: Quality Checks
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v1
+        with:
+          bun-version: 1.2.3
+      - name: Install Dependencies
+        run: bun install --frozen-lockfile
+      - name: Lint Check
+        run: bun run lint
+      - name: Format Check
+        run: bun run format

.gitignore

@@ -0,0 +1,6 @@
+coverage
+dist
+node_modules
+
+.DS_Store
+/*.tgz

.nvmrc

@@ -0,0 +1 @@
+22.11.0

.prettierignore

@@ -0,0 +1,3 @@
+coverage
+dist
+node_modules

.prettierrc

@@ -0,0 +1,3 @@
+{
+  "printWidth": 100
+}

.vscode/settings.json

@@ -0,0 +1,11 @@
+{
+  "editor.codeActionsOnSave": {
+    "source.fixAll": "always"
+  },
+  "editor.formatOnSave": true,
+  "editor.rulers": [100],
+  "files.autoSave": "onFocusChange",
+  "files.insertFinalNewline": true,
+  "editor.tabSize": 2,
+  "editor.trimAutoWhitespace": true
+}

README.md

@@ -0,0 +1,62 @@
+<p>
+  <img width="100%" src="https://assets.solidjs.com/banner?type=Ecosystem&background=tiles&project=library-name" alt="solid-create-script">
+</p>
+
+# Template: SolidJS Library
+
+Template for [SolidJS](https://www.solidjs.com/) library package. Bundling of the library is managed by [tsup](https://tsup.egoist.dev/).
+
+Other things configured include:
+
+- Bun (for dependency management and running scripts)
+- TypeScript
+- ESLint / Prettier
+- Solid Testing Library + Vitest (for testing)
+- Playground app using library
+- GitHub Actions (for all CI/CD)
+
+## Getting Started
+
+Some pre-requisites before install dependencies:
+
+- Install Node Version Manager (NVM)
+  ```bash
+  curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.7/install.sh | bash
+  ```
+- Install Bun
+  ```bash
+  curl -fsSL https://bun.sh/install | bash
+  ```
+
+### Installing Dependencies
+
+```bash
+nvm use
+bun install
+```
+
+### Local Development Build
+
+```bash
+bun start
+```
+
+### Linting & Formatting
+
+```bash
+bun run lint    # checks source for lint violations
+bun run format  # checks source for format violations
+
+bun run lint:fix    # fixes lint violations
+bun run format:fix  # fixes format violations
+```
+
+### Contributing
+
+The only requirements when contributing are:
+
+- You keep a clean git history in your branch
+  - rebasing `main` instead of making merge commits.
+- Using proper commit message formats that adhere to [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+  - Additionally, squashing (via rebase) commits that are not [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/)
+- CI checks pass before merging into `main`

bun.lock

@@ -0,0 +1,63 @@
+import js from "@eslint/js";
+import simpleImportSort from "eslint-plugin-simple-import-sort";
+import solid from "eslint-plugin-solid/configs/typescript";
+import globals from "globals";
+import tseslint from "typescript-eslint";
+
+export default tseslint.config(
+  {
+    // config with just ignores is the replacement for `.eslintignore`
+    ignores: ["**/build/**", "**/coverage/**", "**/dist/**", "**/node_modules/**"],
+  },
+  js.configs.recommended,
+  tseslint.configs.strict,
+  {
+    plugins: {
+      "simple-import-sort": simpleImportSort,
+    },
+    rules: {
+      "simple-import-sort/imports": "error",
+      "simple-import-sort/exports": "error",
+    },
+  },
+  {
+    files: ["**/*.ts", "**/*.tsx"],
+    languageOptions: {
+      parser: tseslint.parser,
+      parserOptions: {
+        sourceType: "module",
+        project: "./tsconfig.json",
+        ecmaFeatures: {
+          jsx: true,
+        },
+      },
+      globals: {
+        ...globals.browser,
+        ...globals.es2022,
+      },
+    },
+    plugins: solid.plugins,
+    rules: {
+      ...solid.rules,
+      "@typescript-eslint/no-non-null-assertion": "off",
+      "no-unused-vars": "off",
+      "@typescript-eslint/no-unused-vars": [
+        "error",
+        {
+          varsIgnorePattern: "^_",
+          argsIgnorePattern: "^_",
+          destructuredArrayIgnorePattern: "^_",
+        },
+      ],
+    },
+  },
+  {
+    files: ["__tests__/**/*.ts", "__tests__/**/*.tsx"],
+    languageOptions: {
+      globals: {
+        ...globals.node,
+        ...globals.vitest,
+      },
+    },
+  },
+);