chore: basic and core configuration for typescript monorepo

.commitlintrc.js

@@ -0,0 +1,21 @@
+const fs = require("node:fs")
+const path = require("node:path")
+
+const packages = fs.readdirSync(path.resolve(__dirname, "packages"))
+const apps = fs.readdirSync(path.resolve(__dirname, "apps"))
+
+module.exports = {
+    extends: ["@commitlint/config-conventional"],
+    prompt: {
+        scopes: [...packages, ...apps],
+        markBreakingChangeMode: true,
+        allowCustomIssuePrefix: false,
+        allowEmptyIssuePrefix: false,
+        issuePrefixes: [
+            {
+                value: "re",
+                name: "re: ISSUES related"
+            }
+        ]
+    }
+}

.editorconfig

@@ -0,0 +1,13 @@
+#root = true
+
+[*]
+indent_style = space
+end_of_line = lf
+charset = utf-8
+trim_trailing_whitespace = true
+insert_final_newline = true
+max_line_length = 120
+indent_size = 4
+
+[*.md]
+trim_trailing_whitespace = false

.gitattributes

@@ -0,0 +1 @@
+*.sol linguist-language=Solidity

.gitignore

@@ -0,0 +1,93 @@
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+lerna-debug.log*
+.pnpm-debug.log*
+
+# Diagnostic reports (https://nodejs.org/api/report.html)
+report.[0-9]*.[0-9]*.[0-9]*.[0-9]*.json
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# IDE
+.vscode
+.idea
+
+# Testing
+coverage
+coverage.json
+*.lcov
+
+# Dependency directories
+node_modules/
+
+# TypeScript cache
+*.tsbuildinfo
+
+# Optional npm cache directory
+.npm
+.DS_Store
+
+# Output of 'npm pack'
+*.tgz
+
+# Optional eslint cache
+.eslintcache
+
+# Microbundle cache
+.rpt2_cache/
+.rts2_cache_cjs/
+.rts2_cache_es/
+.rts2_cache_umd/
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variable files
+.env
+.env.development.local
+.env.test.local
+.env.production.local
+.env.local
+
+# Production
+build
+dist
+/docs
+
+# Docusaurus cache and generated files
+.docusaurus
+.cache-loader
+
+# Hardhat
+artifacts
+cache
+typechain-types
+
+# Stores VSCode versions used for testing VSCode extensions
+.vscode-test
+
+# yarn v3
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+# asdf
+.tool-versions
+
+# direnv
+.envrc

.husky/commit-msg

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

.husky/pre-commit

@@ -0,0 +1 @@
+npx lint-staged

.husky/prepare-commit-msg

@@ -0,0 +1,3 @@
+if [ "$NO_HOOK" != "1" ]; then
+  exec < /dev/tty && npx czg --hook || true
+fi

.lintstagedrc.json

@@ -0,0 +1,3 @@
+{
+    "**/*.{js,ts,md,json,sol,yaml,yml}": "prettier --write"
+}

.prettierignore

@@ -0,0 +1,38 @@
+# dependencies
+node_modules
+package-lock.json
+yarn.lock
+.yarn
+
+# testing
+coverage
+coverage.json
+
+# hardhat
+artifacts
+cache
+typechain-types
+
+# production
+dist
+build
+/docs
+
+# github
+.github/ISSUE_TEMPLATE
+
+# Docusaurus cache and generated files
+.docusaurus
+.cache-loader
+
+# mdx file
+*.mdx
+
+# misc
+.DS_Store
+*.pem
+
+# debug
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*

.prettierrc.json

@@ -0,0 +1,5 @@
+{
+    "semi": false,
+    "arrowParens": "always",
+    "trailingComma": "none"
+}

.yarnrc.yml

@@ -0,0 +1,9 @@
+yarnPath: .yarn/releases/yarn-4.5.0.cjs
+
+checksumBehavior: update
+
+compressionLevel: mixed
+
+enableGlobalCache: false
+
+nodeLinker: node-modules

README.md

@@ -1,2 +1,3 @@
 # excubiae
+
 an on-chain flexible & modular framework for implementing custom gatekeepers.

changelogithub.config.json

@@ -0,0 +1,7 @@
+{
+    "types": {
+        "feat": { "title": "🚀 Features" },
+        "fix": { "title": "🐞 Bug Fixes" },
+        "refactor": { "title": "♻️ Refactoring" }
+    }
+}

package.json

@@ -0,0 +1,34 @@
+{
+    "name": "excubiae",
+    "description": "An on-chain flexible & modular framework for implementing custom gatekeepers.",
+    "license": "MIT",
+    "repository": "[email protected]:privacy-scaling-explorations/excubiae.git",
+    "homepage": "https://github.com/privacy-scaling-explorations/excubiae.git",
+    "bugs": "https://github.com/privacy-scaling-explorations/excubiae/issues",
+    "private": true,
+    "packageManager": "[email protected]",
+    "workspaces": [
+        "apps/*",
+        "packages/*",
+        "packages/contracts/contracts"
+    ],
+    "devDependencies": {
+        "@commitlint/cli": "^19.5.0",
+        "@commitlint/config-conventional": "^19.5.0",
+        "@types/node": "^22.5.5",
+        "changelogithub": "^0.13.10",
+        "czg": "^1.9.4",
+        "husky": "^9.1.6",
+        "lint-staged": "^15.2.10",
+        "prettier": "^3.3.3",
+        "ts-node": "^10.9.2",
+        "typescript": "^5.6.2"
+    },
+    "scripts": {
+        "prepare": "husky",
+        "format": "prettier -c .",
+        "format:write": "prettier -w .",
+        "precommit": "lint-staged",
+        "postinstall": "husky && git config --local core.editor cat"
+    }
+}

tsconfig.json

@@ -0,0 +1,26 @@
+{
+    "compilerOptions": {
+        "baseUrl": ".",
+        "strict": true,
+        "target": "ES2020",
+        "module": "NodeNext",
+        "moduleResolution": "NodeNext",
+        "esModuleInterop": true,
+        "preserveConstEnums": true,
+        "resolveJsonModule": true,
+        "skipLibCheck": true,
+        "declaration": true,
+        "allowSyntheticDefaultImports": true,
+        "declarationDir": "types",
+        "typeRoots": ["node_modules/@types", "types"],
+        "paths": {
+            "@excubiae/*": ["./packages/*/src"]
+        }
+    },
+    "ts-node": {
+        "compilerOptions": {
+            "target": "esnext",
+            "module": "commonjs"
+        }
+    }
+}