@papit/create 0.0.1

package/asset/package-templates/theme/asset/translations/en.json

@@ -0,0 +1,7 @@
+{
+  "meta": {
+    "region": "GB",
+    "language": "en-UK"
+  },
+  "VARIABLE_NAME": "VARIABLE_NAME"
+}

package/asset/package-templates/theme/package.json

@@ -0,0 +1,70 @@
+{
+    "name": "VARIABLE_FULL_NAME",
+    "description": "VARIABLE_DESCRIPTION",
+    "keywords": [
+        "papit",
+        "typescript",
+        "VARIABLE_NAME"
+    ],
+    "version": "0.0.1",
+    "scripts": {
+        "watch": "tsc -w",
+        "start": "npx @papit/server --info --live",
+        "test": "npx playwright test -c tests/playwright.config.ts $@",
+        "preversion": "papit-version",
+        "postversion": "papit-version",
+        "component": "npm create @papit -- --component",
+        "test:update-snapshots": "npx playwright test --update-snapshots -c tests/playwright.config.ts",
+        "test:chrome": "npm test -- --project=chromium"
+    },
+    "type": "module",
+    "files": [
+        "asset/",
+        "lib/"
+    ],
+    "style": "./lib/theme.css",
+    "exports": {
+        ".": "./lib/theme.css",
+        "./theme.css": "./lib/theme.css"
+    },
+    "author": "VARIABLE_USER",
+    "private": false,
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "license": "VARIABLE_PROJECTLICENSE",
+    "homepage": "VARIABLE_GITHUB_REPO/tree/main/VARIABLE_LOCAL_DESTINATION",
+    "bugs": {
+        "url": "VARIABLE_GITHUB_REPO/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "VARIABLE_GITHUB_REPO.git",
+        "directory": "VARIABLE_LOCAL_DESTINATION"
+    },
+    "sideEffects": true,
+    "engines": {
+        "node": ">=18"
+    },
+    "dependencies": {},
+    "devDependencies": {
+        "@playwright/test": "1.58.0",
+        "playwright": "1.58.0",
+        "typescript": "5.9.3",
+        "@papit/theme": "*",
+        "@papit/translator": "*",
+        "@papit/codeblock": "*"
+    },
+    "browserslist": [
+        "defaults",
+        "not IE 11",
+        "not dead"
+    ],
+    "papit": {
+        "publish": true,
+        "type": "theme",
+        "main": "VARIABLE_NAME",
+        "components": {}
+    }
+}

package/asset/package-templates/theme/tests/playwright.config.ts

@@ -0,0 +1,81 @@
+import { Arguments } from "@papit/arguments";
+import { Information, PackageGraph } from "@papit/information";
+import { defineConfig, devices } from '@playwright/test';
+import path from "node:path";
+
+const dirname = path.join(PackageGraph.get("VARIABLE_FULL_NAME").location, "tests");
+// const relative = path.relative(Information.root.location, PackageGraph.get("@papit/web-component").location);
+
+export default defineConfig({
+    // Look for test files in the "tests" directory, relative to this configuration file.
+    testDir: dirname,
+
+    // Run all tests in parallel.
+    fullyParallel: true,
+
+    // Fail the build on CI if you accidentally left test.only in the source code.
+    forbidOnly: !!process.env.CI,
+
+    // Retry on CI only.
+    retries: 0,
+
+    // Opt out of parallel tests on CI.
+    workers: !!process.env.CI ? 1 : undefined,
+
+    // reporter, with output path for HTML reports.
+    reporter: [[
+        !!process.env.CI ? "github" : "html",
+        {
+            open: "never",
+            outputFolder: path.join(dirname, "test-reports"),
+        }
+    ]],
+
+    outputDir: path.join(dirname, "test-results"),
+
+    snapshotPathTemplate: '{testDir}/snapshots/{projectName}/{testFilePath}/{arg}-{platform}{ext}',
+
+    use: {
+        // Base URL to use in actions like `await page.goto('/')`.
+        baseURL: process.env.LOCATION ? `http://localhost:3500/${process.env.LOCATION}/` : 'http://localhost:3500/',
+
+        // Collect trace when retrying the failed test.
+        trace: 'on-first-retry',
+        screenshot: 'only-on-failure',
+    },
+
+
+    expect: {
+        toHaveScreenshot: {
+            maxDiffPixels: 100,
+            maxDiffPixelRatio: 0.2,
+        },
+    },
+    testIgnore: process.env.SKIP_SNAPSHOTS === "true"
+        ? ["**/snapshot.test.ts"]
+        : [],
+
+    // Configure projects for major browsers.
+    projects: [
+        {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] },
+        },
+        {
+            name: 'firefox',
+            use: { ...devices['Desktop Firefox'] },
+        },
+        {
+            name: 'webkit',
+            use: { ...devices['Desktop Safari'] },
+        },
+    ],
+    // running web-server before starting tests 
+    webServer: {
+        command: 'npx @papit/server --serve --port=3500 --bundle',
+        url: 'http://localhost:3500',
+        reuseExistingServer: true,
+        stdout: 'pipe',
+        stderr: 'pipe'
+    },
+});

package/asset/package-templates/theme/tsconfig.json

@@ -0,0 +1,39 @@
+{
+    "compilerOptions": {
+        "target": "es2018",
+        "module": "esnext",
+        "moduleResolution": "node",
+        "noEmitOnError": true,
+        "lib": [
+            "es2020",
+            "dom",
+            "dom.iterable",
+            "esnext"
+        ],
+        "strict": true,
+        "esModuleInterop": false,
+        "allowSyntheticDefaultImports": true,
+        "experimentalDecorators": true,
+        "outDir": "lib",
+        "sourceMap": true,
+        "inlineSources": true,
+        "rootDir": "./",
+        "allowJs": true,
+        "declarationDir": "lib/types",
+        "declaration": true,
+        "incremental": true,
+        "resolveJsonModule": true,
+        "tsBuildInfoFile": ".temp/build/tsconfig.tsbuildinfo",
+        "baseUrl": "src",
+        "paths": {
+            "VARIABLE_FULL_NAME": [
+                "./index"
+            ],
+        }
+    },
+    "include": [
+        "src",
+        "views",
+        "tests"
+    ]
+}

package/asset/package-templates/theme/tsconfig.prod.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "sourceMap": false,
+        "inlineSources": false,
+        "declarationMap": false,
+        "incremental": false
+    }
+}

package/asset/package-templates/web-component/README.md

@@ -0,0 +1,55 @@
+# VARIABLE_FULL_NAME
+
+VARIABLE_DESCRIPTION
+
+![Logo](VARIABLE_GITHUB_REPO/blob/main/asset/logo.svg)
+
+---
+
+![Type](https://img.shields.io/badge/Type-VARIABLE_LAYER_FOLDER-orange)
+[![Tests](VARIABLE_GITHUB_REPO/actions/workflows/pull-request.yml/badge.svg)](VARIABLE_GITHUB_REPO/actions/workflows/pull-request.yml)
+[![NPM version](https://img.shields.io/npm/v/VARIABLE_FULL_NAME.svg?logo=npm)](https://www.npmjs.com/package/VARIABLE_FULL_NAME)
+
+---
+
+## installation
+
+```bash
+npm install VARIABLE_FULL_NAME
+```
+
+### to use in **html**
+
+```html
+<script type="module" defer>
+  import "VARIABLE_FULL_NAME";
+</script>
+
+<VARIABLE_HTML_NAME></VARIABLE_HTML_NAME>
+```
+
+
+## Contributing
+
+Contributions are welcome! Please follow the development guidelines above and ensure all tests pass before submitting a pull request.
+
+## License
+
+Licensed under the @Papit License 1.0 - Copyright (c) 2024 Henry Pap (@onkelhoy)
+
+**Key points:**
+
+- ✅ Free to use in commercial projects
+- ✅ Free to modify and distribute
+- ✅ Attribution required
+- ❌ Cannot resell the component itself as a standalone product
+
+See the [LICENSE](https://github.com/onkelhoy/papit/blob/main/LICENSE) file for full details.
+
+## Related Components
+
+- [@papit/web-component](https://github.com/onkelhoy/papit/tree/main/packages/system/core): Core utilities, decorators, and base component class
+
+## Support
+
+For issues, questions, or contributions, please visit the [GitHub repository](https://github.com/onkelhoy/papit).

package/asset/package-templates/web-component/asset/translations/en.json

@@ -0,0 +1,7 @@
+{
+  "meta": {
+    "region": "GB",
+    "language": "en-UK"
+  },
+  "VARIABLE_NAME": "VARIABLE_NAME"
+}

package/asset/package-templates/web-component/package.json

@@ -0,0 +1,79 @@
+{
+    "name": "VARIABLE_FULL_NAME",
+    "description": "VARIABLE_DESCRIPTION",
+    "keywords": [
+        "papit",
+        "web-component",
+        "typescript",
+        "VARIABLE_NAME"
+    ],
+    "version": "0.0.1",
+    "scripts": {
+        "build": "npx @papit/build --error",
+        "watch": "tsc -w",
+        "start": "npx @papit/server --info --live",
+        "test": "npx playwright test -c tests/playwright.config.ts $@",
+        "preversion": "papit-version",
+        "postversion": "papit-version",
+        "component": "npm create @papit --component",
+        "test:update-snapshots": "npx playwright test --update-snapshots -c tests/playwright.config.ts",
+        "test:chrome": "npm test -- --project=chromium",
+        "build:react": "bash ./bin/_utils/react.sh"
+    },
+    "main": "./lib/bundle.js",
+    "types": "./lib/bundle.d.ts",
+    "type": "module",
+    "files": [
+        "asset/",
+        "lib/"
+    ],
+    "exports": {
+        ".": {
+            "import": "./lib/bundle.js",
+            "types": "./lib/bundle.d.ts"
+        }
+    },
+    "author": "VARIABLE_USER",
+    "private": false,
+    "publishConfig": {
+        "access": "public",
+        "registry": "https://registry.npmjs.org/"
+    },
+    "license": "VARIABLE_PROJECTLICENSE",
+    "homepage": "VARIABLE_GITHUB_REPO/tree/main/VARIABLE_LOCAL_DESTINATION",
+    "bugs": {
+        "url": "VARIABLE_GITHUB_REPO/issues"
+    },
+    "repository": {
+        "type": "git",
+        "url": "VARIABLE_GITHUB_REPO.git",
+        "directory": "VARIABLE_LOCAL_DESTINATION"
+    },
+    "sideEffects": true,
+    "engines": {
+        "node": ">=18"
+    },
+    "dependencies": {
+        "@papit/web-component": "*"
+    },
+    "devDependencies": {
+        "@playwright/test": "1.58.0",
+        "playwright": "1.58.0",
+        "typescript": "5.9.3",
+        "@papit/theme": "*",
+        "@papit/translator": "*",
+        "@papit/codeblock": "*"
+    },
+    "browserslist": [
+        "defaults",
+        "not IE 11",
+        "not dead"
+    ],
+    "papit": {
+        "publish": true,
+        "type": "web-component",
+        "main": "VARIABLE_NAME",
+        "htmlprefix": "VARIABLE_HTML_PREFIX",
+        "components": {}
+    }
+}

package/asset/package-templates/web-component/src/global-css.d.ts

@@ -0,0 +1,4 @@
+declare module "*.css" {
+    const sheet: CSSStyleSheet;
+    export default sheet;
+}

package/asset/package-templates/web-component/tests/playwright.config.ts

@@ -0,0 +1,81 @@
+import { Arguments } from "@papit/arguments";
+import { Information, PackageGraph } from "@papit/information";
+import { defineConfig, devices } from '@playwright/test';
+import path from "node:path";
+
+const dirname = path.join(PackageGraph.get("VARIABLE_FULL_NAME").location, "tests");
+// const relative = path.relative(Information.root.location, PackageGraph.get("@papit/web-component").location);
+
+export default defineConfig({
+    // Look for test files in the "tests" directory, relative to this configuration file.
+    testDir: dirname,
+
+    // Run all tests in parallel.
+    fullyParallel: true,
+
+    // Fail the build on CI if you accidentally left test.only in the source code.
+    forbidOnly: !!process.env.CI,
+
+    // Retry on CI only.
+    retries: 0,
+
+    // Opt out of parallel tests on CI.
+    workers: !!process.env.CI ? 1 : undefined,
+
+    // reporter, with output path for HTML reports.
+    reporter: [[
+        !!process.env.CI ? "github" : "html",
+        {
+            open: "never",
+            outputFolder: path.join(dirname, "test-reports"),
+        }
+    ]],
+
+    outputDir: path.join(dirname, "test-results"),
+
+    snapshotPathTemplate: '{testDir}/snapshots/{projectName}/{testFilePath}/{arg}-{platform}{ext}',
+
+    use: {
+        // Base URL to use in actions like `await page.goto('/')`.
+        baseURL: process.env.LOCATION ? `http://localhost:3500/${process.env.LOCATION}/` : 'http://localhost:3500/',
+
+        // Collect trace when retrying the failed test.
+        trace: 'on-first-retry',
+        screenshot: 'only-on-failure',
+    },
+
+
+    expect: {
+        toHaveScreenshot: {
+            maxDiffPixels: 100,
+            maxDiffPixelRatio: 0.2,
+        },
+    },
+    testIgnore: process.env.SKIP_SNAPSHOTS === "true"
+        ? ["**/snapshot.test.ts"]
+        : [],
+
+    // Configure projects for major browsers.
+    projects: [
+        {
+            name: 'chromium',
+            use: { ...devices['Desktop Chrome'] },
+        },
+        {
+            name: 'firefox',
+            use: { ...devices['Desktop Firefox'] },
+        },
+        {
+            name: 'webkit',
+            use: { ...devices['Desktop Safari'] },
+        },
+    ],
+    // running web-server before starting tests 
+    webServer: {
+        command: 'npx @papit/server --serve --port=3500 --bundle',
+        url: 'http://localhost:3500',
+        reuseExistingServer: true,
+        stdout: 'pipe',
+        stderr: 'pipe'
+    },
+});

package/asset/package-templates/web-component/tests/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+        "rootDir": ".."
+    },
+    "include": [
+        "."
+    ]
+}

package/asset/package-templates/web-component/tsconfig.json

@@ -0,0 +1,42 @@
+{
+    "compilerOptions": {
+        "target": "es2018",
+        "module": "esnext",
+        "moduleResolution": "bundler",
+        // "moduleDetection": "force",
+        "noEmitOnError": true,
+        "skipLibCheck": true,
+        "lib": [
+            "es2020",
+            "dom",
+            "dom.iterable",
+            "esnext"
+        ],
+        "jsx": "react-jsx",
+        "strict": true,
+        "verbatimModuleSyntax": false,
+        "noUncheckedIndexedAccess": false, // use me for strict array/object access checks
+        "esModuleInterop": true,
+        "allowSyntheticDefaultImports": true,
+        "experimentalDecorators": true,
+        "useDefineForClassFields": false,
+        "outDir": "lib",
+        "rootDir": "src",
+        "declaration": true,
+        "resolveJsonModule": true,
+        "allowJs": true,
+        "baseUrl": "src",
+        "paths": {
+            "VARIABLE_FULL_NAME": [
+                "./index"
+            ]
+        },
+        "sourceMap": true,
+        "inlineSources": true,
+        "incremental": true,
+        "tsBuildInfoFile": ".temp/build/tsconfig.tsbuildinfo",
+    },
+    "include": [
+        "src"
+    ]
+}

package/asset/package-templates/web-component/tsconfig.prod.json

@@ -0,0 +1,9 @@
+{
+    "extends": "./tsconfig.json",
+    "compilerOptions": {
+        "sourceMap": false,
+        "inlineSources": false,
+        "declarationMap": false,
+        "incremental": false
+    }
+}

package/asset/package-templates/web-component/views/tsconfig.json

@@ -0,0 +1,9 @@
+{
+    "extends": "../tsconfig.json",
+    "compilerOptions": {
+        "rootDir": ".."
+    },
+    "include": [
+        "."
+    ]
+}

package/asset/project-template/.eslintrc

@@ -0,0 +1,26 @@
+{
+  "parserOptions": {
+    "ecmaVersion": 2021, // or a later version
+    "sourceType": "module", // if you're using ES6 modules
+    "ecmaFeatures": {
+      "experimentalObjectRestSpread": true // Enable support for class properties
+    }
+  },
+  "env": {
+    "es6": true, // Make sure ES6 globals are enabled,
+    "node": true
+  },
+  "rules": {
+    "brace-style": [
+      "error",
+      "allman",
+      {
+        "allowSingleLine": true
+      }
+    ],
+    "indent": [
+      "error",
+      2
+    ]
+  }
+}

package/asset/project-template/.gitattributes

@@ -0,0 +1 @@
+*.json  linguist-language=JSON-with-Comments

package/asset/project-template/.github/ISSUE_TEMPLATE/CONTRIBUTING.md

@@ -0,0 +1,101 @@
+# Git Workflow Guide
+
+This document outlines the recommended workflow for handling tasks within our projects, emphasizing the use of git for version control. To ensure clarity, maintainability, and a clean project history, we adhere to specific practices for branching, committing, and merging changes.
+
+## Branch Management
+
+For every task, whether it involves fixing bugs, adding features, or making minor updates, a new branch should be created. This approach keeps our project organized and ensures that each change is easily traceable to a specific task or issue.
+
+### Branch Creation Process
+
+Follow these steps to start working on a new task:
+
+1. Open a new issue in the project's GitHub repository to document the task or bug.
+2. Create a branch for the task. Utilizing the GitHub GUI for both steps is recommended for convenience and consistency.
+
+## Commit Guidelines
+
+Commit messages should clearly describe the changes made, following a structured prefix syntax to facilitate quick understanding and categorization of the commit's purpose.
+
+### Standard Commit Syntax
+
+For general changes:
+
+```bash
+git commit -m "prefix: description"
+```
+
+For changes specific to a component:
+
+```bash
+git commit -m "prefix: [component-name] description"
+```
+
+For example:
+
+```bash
+git commit -m "fix: [button] trigger click on enter press"
+```
+
+### Commit Prefixes
+
+While the following prefixes are recommended, they are not exhaustive. Feel free to introduce new prefixes as needed, but aim for consistency and clarity across the project.
+
+- **fix**: For fixes that correct bugs or issues.
+- **bug**: Specifically for bug fixes.
+- **chore**: For maintenance tasks that do not alter functionality.
+- **add**: When adding new features or elements.
+- **clean**: For clean-up tasks that improve the code without changing functionality.
+- **style**: For changes related to styling and appearance.
+- **react**: For changes specific to React components or functionality.
+- **release**: For version releases and related tasks.
+- **gen**: For auto-generated content or files.
+- **resolve**: To indicate that an issue has been resolved, useful for final commits related to fixing a problem.
+
+## Merging Changes
+
+Once your branch's task is completed, ensure it is integrated seamlessly with the main branch. This process involves updating your branch with the latest changes from the main branch and consolidating your work into a well-documented commit.
+
+### Finalizing Your Branch for Merge
+
+1. Update the main branch with the latest changes:
+
+    ```bash
+    git checkout main
+    git pull
+    ```
+
+2. Switch back to your task branch:
+
+    ```bash
+    git checkout your-branch-name
+    ```
+
+3. Start the rebase process interactively:
+
+    ```bash
+    git rebase -i main
+    ```
+
+    During the rebase, squash your commits into a single commit that captures the essence of your branch's work.
+
+4. Craft a comprehensive commit message that includes a changelog listing all significant changes. Ensure the branch's purpose is clear, and link the issue ticket using GitHub's syntax to automatically close the related issue upon merging.
+
+#### Commit Message Example
+
+```
+resolve: [button] Ensure click is triggered on enter press
+closes: #888
+changelog:
+- fix: Corrected event handling
+- clean: Optimized button click logic
+```
+
+### Tips for Effective Rebasing
+
+Utilize Vim commands to streamline the rebase process:
+
+- To squash all commits: `%s/pick /s /g`
+- To format commit messages as a list during the rebase: `:%s/\([^:]\+\): /- \1: /g`
+
+Adhering to these guidelines will help maintain a clean, understandable, and navigable project history, facilitating collaboration and review processes.