@theholocron/react-template 0.1.0 → 0.2.1

package/README.md

@@ -1,6 +1,6 @@
-# react-template
+# React Template
 
-<description> used within the Galaxy.
+A React template used within the Galaxy.
 
 ## Installation
 
@@ -10,8 +10,20 @@ npm install --save-dev @theholocron/react-template
 
 ## Usage
 
-<!-- fill out the usage with examples -->
+```typescript
+import { Component, type ComponentProps } from "@theholocron/react-template";
+
+function App (props: ComponentProps) {
+	return (
+		<Component {...props} />
+	);
+}
+```
 
 ## Documentation
 
-<!-- document the api(s), or how to use with examples -->
+The best way to find out what's available is to check out the [documentation site](https://docs.theholocron.dev/react-template/), but if you like digging through source code, then each component is typed via TypeScript.
+
+**Note**
+
+We use [SuperLinter](https://github.com/super-linter) for all linting checks on `push` and `pull_request` events. One of those tools is [Gitleaks](https://github.com/gitleaks/gitleaks), which protects and discovers secrets that happen to sneak into code commits. There are other ways to install Gitleaks, but you **ARE** required to install it locally as it runs on a `pre-commit` Git hook. To install, run `brew install gitleaks` or check their documentation for other options.

package/package.json

@@ -3,7 +3,22 @@
   "description": "<description>",
   "homepage": "https://github.com/theholocron/react-template#readme",
   "author": "Newton Koumantzelis",
-  "version": "0.1.0",
+  "main": "dist/react-template.cjs.js",
+  "module": "dist/react-template.es.js",
+  "style": "dist/style.css",
+  "types": "dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/react-template.es.js",
+      "require": "./dist/react-template.cjs.js"
+    },
+    "./style": "./dist/style.css"
+  },
+  "files": [
+    "dist/*"
+  ],
+  "type": "module",
+  "version": "0.2.1",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/theholocron/react-template.git"
@@ -13,36 +28,56 @@
   "wiki": "https://github.com/theholocron/react-template/wiki",
   "license": "GPL-3.0",
   "packageManager": "npm@9.5.0",
-  "commitlint": {
-    "extends": "@theholocron"
-  },
-  "eslintConfig": {
-    "extends": "@theholocron"
+  "bundlewatch": {
+    "files": [
+      {
+        "path": "./dist/**/*.css",
+        "maxSize": "50 kB"
+      },
+      {
+        "path": "./dist/**/*.js",
+        "maxSize": "100 kB"
+      }
+    ]
   },
-  "jest": {
-    "displayName": "react-template",
-    "preset": "@theholocron/jest-config"
+  "msw": {
+    "workerDirectory": "public"
   },
   "publishConfig": {
     "access": "public"
   },
-  "prettier": "@theholocron/prettier-config",
   "scripts": {
-    "build": "tsc --noEmit",
-    "lint": "eslint --ignore-path .gitignore '**/*.{js,jsx,ts,tsx}'",
+    "dev": "vite",
+    "build": "vite build",
+    "build:storybook": "storybook build",
+    "lint": "docker run -e LOG_LEVEL=DEBUG -e RUN_LOCAL=true -v .:/tmp/lint --rm ghcr.io/super-linter/super-linter:latest",
+    "preview": "vite preview",
     "release": "changeset",
-    "start": "",
-    "test": "jest"
+    "start": "storybook dev -p 6006",
+    "test": "vitest",
+    "test:cypress": "cypress open",
+    "test:storybook": "test-storybook --coverage"
   },
   "devDependencies": {
     "@changesets/changelog-github": "^0.5.0",
     "@changesets/cli": "^2.27.9",
-    "@theholocron/bundlewatch-config": "^3.1.0",
-    "@theholocron/commitlint-config": "^3.1.0",
-    "@theholocron/eslint-config": "^3.1.0",
-    "@theholocron/jest-config": "^3.1.0",
-    "@theholocron/lint-staged-config": "^3.1.0",
-    "@theholocron/prettier-config": "^3.1.0",
-    "@theholocron/tsconfig": "^3.1.0"
+    "@theholocron/commitlint-config": "^3.4.4",
+    "@theholocron/eslint-config": "^3.4.4",
+    "@theholocron/jest-config": "^3.4.4",
+    "@theholocron/lint-staged-config": "^3.4.4",
+    "@theholocron/prettier-config": "^3.4.4",
+    "@theholocron/storybook-config": "^3.4.4",
+    "@theholocron/stylelint-config": "^3.4.4",
+    "@theholocron/tsconfig": "^3.4.4",
+    "@tsconfig/vite-react": "^3.0.2",
+    "@vitejs/plugin-react": "^4.3.2",
+    "alexjs": "^1.0.0",
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1",
+    "vite": "^5.4.9"
+  },
+  "peerDependencies": {
+    "react": "^18.3.1",
+    "react-dom": "^18.3.1"
   }
 }

package/.alexignore

@@ -1,3 +0,0 @@
-.github/*
-CHANGELOG.md
-LICENSE

package/.changeset/README.md

@@ -1,8 +0,0 @@
-# Changesets
-
-Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
-with multi-package repos, or single-package repos to help you version and publish your code. You can
-find the full documentation for it [in our repository](https://github.com/changesets/changesets)
-
-We have a quick list of common questions to get you started engaging with this project in
-[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

package/.changeset/config.json

@@ -1,8 +0,0 @@
-{
-  "$schema": "https://unpkg.com/@changesets/config@3.0.3/schema.json",
-  "access": "public",
-  "baseBranch": "main",
-  "changelog": ["@changesets/changelog-github", {"repo": "theholocron/configs"}],
-  "commit": false,
-  "updateInternalDependencies": "patch"
-}

package/.editorconfig

@@ -1,24 +0,0 @@
-root = true
-
-[*]
-end_of_line = lf
-charset = utf-8
-trim_trailing_whitespace = true
-insert_final_newline = true
-indent_style = tab
-indent_size = 4
-
-[.gitattributes]
-indent_style = space
-indent_size = 2
-
-[*.{json,yml}]
-indent_style = space
-indent_size = 2
-
-[*.md]
-trim_trailing_whitespace = false
-
-[.*{rc,ignore}]
-indent_style = space
-indent_size = 2

package/.gitattributes

@@ -1,12 +0,0 @@
-# Enforce Unix newlines
-*.css   text eol=lf
-*.html  text eol=lf
-*.js    text eol=lf
-*.json  text eol=lf
-*.scss  text eol=lf
-*.md    text eol=lf
-*.svg   text eol=lf
-*.yml   text eol=lf
-
-# Don't diff or textually merge source maps
-*.map   binary

package/.github/CODEOWNERS

@@ -1 +0,0 @@
-* @theholocron/gatekeepers

package/.github/dependabot.yml

@@ -1,6 +0,0 @@
-version: 2
-updates:
-  - package-ecosystem: "npm"
-    directory: "/"
-    schedule:
-      interval: "weekly"

package/.github/labeler.yml

@@ -1,15 +0,0 @@
-# Add 'docs' label to any changes within 'docs' folder or any subfolders
-# Add 'docs' label to any change to .md files within the entire repository
-documentation:
-- changed-files:
-  - any-glob-to-any-file:
-    - docs/**
-    - '**/*.md'
-
-# Add 'bug' label to any PR where the head branch name starts with `fix` or has a `fix` section in the name
-bug:
- - head-branch: ['^fix', 'fix']
-
-# Add 'enhancement' label to any PR where the head branch name starts with `feature` or has a `feature` section in the name
-enhancement:
- - head-branch: ['^feat', 'feature']

package/.github/workflows/audit.yml

@@ -1,28 +0,0 @@
-name: "Audit"
-
- on:
-   pull_request:
-     types: [synchronize, opened]
-
- jobs:
-   bundlewatch:
-     runs-on: ubuntu-latest
-     steps:
-       - name: Checkout
-         uses: actions/checkout@v4
-
-       - name: Set up Node.js
-         uses: actions/setup-node@v4
-         with:
-           node-version: 20
-           cache: "npm"
-
-       - name: Install dependencies
-       - run: npm ci
-
-       - name: Bundlewatch
-       - uses: jackyef/bundlewatch-gh-action@0.3.0
-         with:
-           build-script: npm run build
-           bundlewatch-github-token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}
-           bundlewatch-config: ./node_modules/@theholocron/bundlewatch-config/bundlewatch.config.js

package/.github/workflows/greetings.yml

@@ -1,29 +0,0 @@
-name: Greetings
-
-on: [pull_request, issues]
-
-jobs:
-  greeting:
-    runs-on: ubuntu-latest
-    steps:
-    - uses: actions/first-interaction@v1
-      with:
-        repo-token: ${{ secrets.GITHUB_TOKEN }}
-        issue-message: >
-          Hey @${{ github.event.issue.user.login }}!
-          We really appreciate you taking the time to report an issue. The
-          collaborators on this project attempt to help as many people as
-          possible, but we are a limited number of volunteers, so it is
-          possible that this will not be addressed as swiftly.
-
-          Your patience is much appreciated and we will get back to you as
-          quickly as possible.
-        pr-message: >
-          Hey @${{ github.event.issue.user.login }}!
-          We really appreciate you taking the time to help out with this PR.
-          The collaborators on this project attempt to help as many people as
-          possible, but we are a limited number of volunteers, so it is
-          possible that this will not be addressed as swiftly.
-
-          Your patience is much appreciated and we will get back to you as
-          quickly as possible.

package/.github/workflows/label.yml

@@ -1,15 +0,0 @@
-name: Labeler
-
-on: [pull_request_target]
-
-jobs:
-  label:
-    runs-on: ubuntu-latest
-    permissions:
-      contents: read
-      pull-requests: write
-    steps:
-      - uses: actions/labeler@v4
-        with:
-          sync-labels: true
-          repo-token: "${{ secrets.GITHUB_TOKEN }}"

package/.github/workflows/release.yml

@@ -1,38 +0,0 @@
-name: "Version, Release, & Publish"
-
-on:
-  push:
-    branches: ["main"]
-
-concurrency: ${{ github.workflow }}-${{ github.ref }}
-
-jobs:
-  release:
-    permissions:
-      contents: write # to create release
-      issues: write # to post issue comments
-      pull-requests: write # to create pull request
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout
-        uses: actions/checkout@v4
-
-      - name: Set up Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: 20.x
-          cache: "npm"
-
-      - name: Install dependencies
-        run: npm ci
-
-      - name: Publish to NPM
-        uses: changesets/action@v1
-        with:
-          title: "chore(release): 🦋 version packages"
-          commit: "chore(release): 🦋 version packages"
-          version: npx changeset version
-          publish: npx changeset publish
-        env:
-          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
-          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/stale.yml

@@ -1,24 +0,0 @@
-name: Mark stale issues and pull requests
-
-on:
-  schedule:
-  - cron: "30 1 * * *"
-
-jobs:
-  stale:
-    permissions:
-      contents: write # only for delete-branch option
-      issues: write
-      pull-requests: write
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/stale@v9
-        with:
-          days-before-close: 5
-          days-before-stale: 30
-          exempt-all-pr-milestones: true
-          close-issue-message: 'This issue was closed because it has been stalled for 5 days with no activity.'
-          stale-issue-label: 'wontfix'
-          stale-issue-message: 'This issue is stale because it has been open 30 days with no activity. Remove stale label or comment or this will be closed in 5 days.'
-          stale-pr-label: 'wontfix'
-          stale-pr-message: 'This PR is stale because it has been open 45 days with no activity. Remove stale label or comment or this will be closed in 10 days.'

package/.husky/commit-msg

@@ -1 +0,0 @@
-npx --no -- commitlint --edit $1

package/.husky/pre-commit

@@ -1 +0,0 @@
-npx lint-staged --config @theholocron/lint-staged-config

package/.husky/prepare-commit-msg

@@ -1,18 +0,0 @@
-#!/bin/sh
-
-NAME=$(git config user.name)
-EMAIL=$(git config user.email)
-
-if [ -z "$NAME" ]; then
-	echo "empty git config user.name"
-	exit 1
-fi
-
-if [ -z "$EMAIL" ]; then
-	echo "empty git config user.email"
-	exit 1
-fi
-
-git interpret-trailers --if-exists doNothing --trailer \
-	"Signed-off-by: $NAME <$EMAIL>" \
-	--in-place "$1"

package/tsconfig.json

@@ -1,3 +0,0 @@
-{
-  "extends": "@theholcron/tsconfig/node-next/tsconfig.json"
-}