mentie 0.0.8

package/.eslintrc.cjs

@@ -0,0 +1,7 @@
+// const { eslint_config } = require( './index.cjs' )
+const { eslint_config } = require( 'airier' )
+
+// Export the default eslint config
+module.exports = {
+    ...eslint_config
+}

package/.husky/pre-commit

@@ -0,0 +1,17 @@
+echo "\n🤖 [ precommit hook ] linting before committing..."
+
+# If errors, make it clear they cannot commit
+if ! lint_outcome=$(npm run lint); then
+    echo "🚨 [ precommit hook ] lint encountered blocking issues, fix them before committing\n"
+    echo "$lint_outcome"
+    exit 1
+fi
+
+# If warnings, suggest they fix them
+if echo $lint_outcome | grep -q "warning"; then
+    echo "⚠️ [ precommit hook ] lint encountered warnings, consider fixing them before pushing\n"
+    echo "$lint_outcome"
+    exit 0
+fi
+
+echo "✅ [ precommit hook ] lint encountered no blocking issues\n"

package/.npmrc.bak

@@ -0,0 +1 @@
+//registry.npmjs.org/:_authToken=${NPM_ACCESS_TOKEN}

package/.vscode/settings.json

@@ -0,0 +1,27 @@
+{
+	"i18n-ally.localesPaths": [
+		"public/locales"
+	],
+	"i18n-ally.keystyle": "nested",
+	"eslint.validate": [
+		"javascript",
+		"javascriptreact",
+		"typescript",
+		"typescriptreact"
+	],
+	"editor.codeActionsOnSave": {
+		"source.fixAll.eslint": "explicit"
+	},
+	"editor.renderWhitespace": "all",
+	"editor.formatOnSave": true,
+	"eslint.format.enable": true,
+	"eslint.run": "onType",
+	"explorer.fileNesting.enabled": true,
+	"explorer.fileNesting.patterns": {
+		"vite.config.js": "*.js,.babelrc,.nvmrc,index.html,.gitignore",
+		".env": ".env*,.*.json",
+		"firebase.json": "fire*,.fire*",
+		"package.json": "package-lock.json, yarn.lock, pnpm-lock.yaml,.eslint*,config.*,.npm*,.nvm*,.ncu*",
+		"README.md": "*.md,LICENSE",
+	}
+}

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Proof of Attendance Protocol
+
+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:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,46 @@
+# Opinionated ESLint and VSCode style guide
+
+A shared set of standards and preferences, enforced through eslint and vscode. Priorities: minimalism, readability, documentation.
+
+## Quickstart
+
+```shell
+# Install dependencies
+npm install -D airier @babel/eslint-parser @babel/preset-react eslint eslint-plugin-react eslint-plugin-unused-imports husky
+mkdir .vscode .husky || echo "Directories already exist"
+
+# Create scripts
+npm pkg set scripts.lint="eslint --fix src"
+
+# Init husky
+npx husky init
+
+# Download files
+curl https://raw.githubusercontent.com/actuallymentor/airier/main/.eslintrc.cjs --output .eslintrc.cjs
+curl https://raw.githubusercontent.com/actuallymentor/airier/main/.vscode/settings.json --output .vscode/settings.json
+curl https://raw.githubusercontent.com/actuallymentor/airier/main/.husky/pre-commit --output .husky/pre-commit
+curl https://raw.githubusercontent.com/actuallymentor/airier/main/.babelrc --output .babelrc
+
+# Add files to git
+git add -f .eslintrc.cjs .babelrc .vscode/* .husky/*
+
+# Make husky executable
+chmod ug+x .husky/*
+git add .husky/pre-commit
+```
+
+## Making changes
+
+The relevant source files are in `modules/`. If you make a change, you can update the package by:
+
+1. Making the changes
+1. Updating the version number in `package.json`
+1. Pushing to the main branch of the repo or opening a pull request. Changes are deployed and published through github actions. Publishing requires a version bump in `package.json`.
+
+### Using this repo as a template
+
+If you are cloning this repo and want to reuse it to create an npm package. These are the one-time setup instructions:
+
+1. You need to do the one-time first publishing manually by running `npm publish --access public` in the root of the project. This will create the package on npmjs and allow you to create a granular token. This requires you to rename `.npmrc` to `.npmrc.bak` temporatily.
+1. You need to obtain a NPM_ACCESS_TOKEN on npmjs (https://www.npmjs.com/settings/YOURUSERNAME/tokens/granular-access-tokens/new). Note that granular tokens expire!
+# airier

package/index.js

@@ -0,0 +1,3 @@
+export * from './modules/logging.js'
+export * from './modules/time.js'
+export * from './modules/environment.js'

package/modules/environment.js

@@ -0,0 +1,52 @@
+// ///////////////////////////////
+// Platform and environment detection
+// ///////////////////////////////
+
+/**
+ * Checks if the code is running in a web environment.
+ * @returns {boolean} Returns true if the code is running in a web environment, otherwise returns false.
+ */
+export const is_web = typeof window !== 'undefined'
+/**
+ * Checks if the code is running in a Node environment.
+ * @returns {boolean} Returns true if the code is running in a Node environment, otherwise returns false.
+ */
+export const is_node = typeof process !== 'undefined' && process.versions && process.versions.node
+
+/**
+ * Checks if the code is running in a Firebase functions emulator environment.
+ * @returns {boolean} Returns true if the code is running in a Firebase environment, otherwise returns false.
+ */
+export const is_emulator = process.env.FUNCTIONS_EMULATOR === 'true'
+
+// ///////////////////////////////
+// Mode and loglevel detection
+// ///////////////////////////////
+
+const node_dev = process.env.NODE_ENV === 'development'
+const web_dev = typeof location !== 'undefined' && ( `${ location.href }`.includes( 'debug=true' ) || `${ location.href }`.includes( 'debug=true' ) )
+
+/**
+ * Represents the development environment.
+ * @type {boolean}
+ */
+export const dev = node_dev || web_dev
+
+/**
+ * The log level for web applications.
+ * @type {string}
+ */
+export const web_loglevel = is_web && new URLSearchParams( location.search ).get( 'loglevel' )
+
+/**
+ * The log level for the Node environment.
+ * @type {string}
+ */
+export const node_loglevel = process.env.LOG_LEVEL
+
+
+/**
+ * The log level used in the environment.
+ * @type {string}
+ */
+export const loglevel = web_loglevel || node_loglevel || 'info'

package/modules/logging.js

@@ -0,0 +1,76 @@
+// Import environment data
+import { dev, loglevel } from "./environment.js"
+
+/**
+ * Logs the provided messages to the console.
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn', 'info'.
+ *  🎯 Goal: log informational messages about the state of the application.
+ * @example log( `User state was updated to: `, user )
+ * @param {...any} messages - The messages to be logged.
+ */
+export function log( ...messages ) {
+
+    // Check if the loglevel matches this call
+    const levels = [ 'error', 'warn', 'info' ]
+    const should_log = dev || levels.includes( loglevel )
+
+    // Log the messages if the loglevel matches
+    if( should_log ) console.log( ...messages )
+
+}
+
+/**
+ * Logs the provided info messages to the console.
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn'
+ * 🎯 Goal: log verbose trace messages used only for extremely granular debugging
+ * @example log.verbose( `Retreived key '${ key }' of type '${ typeof key }' from localstorage: `, cache )
+ * @param {...any} messages - The messages to be logged.
+ */
+log.verbose = function( ...messages ) {
+
+    // Check if the loglevel matches this call
+    const levels = [ 'error', 'warn', 'info' ]
+    const should_log = dev || levels.includes( loglevel )
+
+    // Log the messages if the loglevel matches
+    if( should_log ) console.info( ...messages )
+
+}
+
+/**
+ * Logs the provided info messages to the console.
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error', 'warn'
+ * 🎯 Goal: log warnings of things that should not happen, but do not break functionality
+ * @example log.warn( `Transaction history was empty, this should never happen: `, history )
+ * @param {...any} messages - The messages to be logged.
+ */
+log.warn = function( ...messages ) {
+
+    // Check if the loglevel matches this call
+    const levels = [ 'error', 'warn' ]
+    const should_log = dev || levels.includes( loglevel )
+
+    // Log the messages if the loglevel matches
+    if( should_log ) console.warn( ...messages )
+
+}
+
+/**
+ * Logs the provided error messages to the console.
+ * Only logs in development mode OR if ?loglevel= or LOG_LEVEL= is set to one of the following: 'error'
+ * @scope log errors that impact proper functioning of the application
+ * @example log.error( `Error connecting to database: `, error )
+ * @param {...any} messages - The messages to be logged.
+ */
+log.error = function( ...messages ) {
+
+    // Check if the loglevel matches this call
+    const levels = [ 'error' ]
+    const should_log = dev || levels.includes( loglevel )
+    if( !should_log ) return
+
+    // Log the messages if the loglevel matches
+    console.error( ...messages )
+    console.trace()
+
+}

package/modules/time.js

@@ -0,0 +1,6 @@
+/**
+ * Waits for the specified amount of time.
+ * @param {number} ms - The number of milliseconds to wait.
+ * @returns {Promise<void>} - A promise that resolves after the specified time.
+ */
+export const wait = ( ms=0 ) => new Promise( resolve => setTimeout( resolve, ms ) )

package/package.json

@@ -0,0 +1,30 @@
+{
+  "name": "mentie",
+  "version": "0.0.8",
+  "description": "Mentor's toolbelt",
+  "type": "module",
+  "main": "index.js",
+  "scripts": {
+    "lint": "eslint --fix .",
+    "prepare": "husky"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/actuallymentor/mentie.git"
+  },
+  "author": "Mentor <mentor@palokaj.co> (http://github.com/actuallymentor)",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/actuallymentor/mentie/issues"
+  },
+  "homepage": "https://github.com/actuallymentor/mentie#readme",
+  "devDependencies": {
+    "@babel/eslint-parser": "^7.25.1",
+    "@babel/preset-react": "^7.24.7",
+    "airier": "^0.0.8",
+    "eslint": "^8.57.0",
+    "eslint-plugin-react": "^7.35.0",
+    "eslint-plugin-unused-imports": "^3.2.0",
+    "husky": "^9.1.3"
+  }
+}