@startinblox/boilerplate 3.0.0

package/.gitlab-ci.yml

@@ -0,0 +1,57 @@
+---
+include:
+  project: infra/gitlab
+  ref: master
+  file: templates/nodejs.ci.yml
+
+cache:
+  key: ${CI_COMMIT_REF_SLUG}
+  paths:
+    - .npm/
+
+default:
+  image: node:22
+
+stages:
+  - prepare
+  - test
+  - publish
+
+prepare:
+  stage: prepare
+  image: node:22
+  before_script:
+    - npm ci --cache .npm --prefer-offline
+    - npm install -g semantic-release@24 @semantic-release/gitlab@13
+  script:
+    - npm run locale:build
+    - npm run build
+  artifacts:
+    when: on_success
+    paths:
+      - dist
+    expire_in: 1 day
+  tags:
+    - test
+
+test:
+  stage: test
+  image: 
+    name: cypress/included:14.2.0
+    entrypoint: [""]
+  before_script:
+    - npm ci --cache .npm --prefer-offline
+  script:
+    - npm run cy:run
+  except:
+    - tags
+  tags:
+    - test
+
+publish:
+  stage: publish
+  extends: .publish_npm
+  only:
+    - master
+    - beta
+    - alpha

package/.storybook/main.ts

@@ -0,0 +1,15 @@
+import type { StorybookConfig } from "@storybook/web-components-vite";
+
+const config: StorybookConfig = {
+  stories: ["../stories/**/*.stories.@(js|jsx|mjs|ts|tsx)"],
+  addons: ["@storybook/addon-essentials"],
+  framework: {
+    name: "@storybook/web-components-vite",
+    options: {},
+  },
+  docs: {
+    autodocs: "tag",
+  },
+};
+
+export default config;

package/.storybook/preview-head.html

@@ -0,0 +1,8 @@
+<script>
+  window.global = window;
+</script>
+<style>
+  .sbdocs.sbdocs-content {
+    max-width: 1440px;
+  }
+</style>

package/.storybook/preview.ts

@@ -0,0 +1,22 @@
+import type { Preview } from "@storybook/web-components";
+
+import "@styles/index.scss";
+
+import "@mocks/orbit.mock";
+
+const preview: Preview = {
+  parameters: {
+    actions: { argTypesRegex: "^on[A-Z].*" },
+    controls: {
+      matchers: {
+        color: /(background|color)$/i,
+        date: /Date$/i,
+      },
+    },
+    docs: {
+      toc: true,
+    },
+  },
+};
+
+export default preview;

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024-PRESENT Startin blox
+
+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,85 @@
+# Boilerplate
+
+## Table of Contents
+
+1. [Introduction](#introduction)
+2. [Installation](#installation)
+3. [Development](#development)
+4. [Tests](#tests)
+5. [Storybook](#storybook)
+6. [Build](#build)
+7. [License](#license)
+
+## Introduction
+
+This is a boilerplate of startin'blox component.
+
+## Installation
+
+```bash
+npm install
+```
+
+## Development
+
+```bash
+npm run watch
+```
+
+## Tests
+
+```bash
+npm run cy:run
+```
+
+or
+
+```bash
+npm run cy:open
+```
+
+## Storybook
+
+```bash
+npm run storybook
+```
+
+## Build
+
+```bash
+npm run build
+```
+
+## Localization
+
+This project uses [`@lit/localize`](https://www.npmjs.com/package/@lit/localize) for internationalization.
+
+### Extracting strings
+
+To extract strings for translation, run:
+
+```bash
+npm run locale:extract
+```
+
+This command will generate XLIFF files in the `locales` directory.
+
+### Changing locale
+
+To change the locale, run:
+
+```javascript
+window.setLocale.map((setLocale) => setLocale("your-lang-code"));
+```
+
+### Getting current locale
+
+To get the current locale, run:
+
+```javascript
+window.getLocale.map((locale) => console.log(locale));
+```
+
+## License
+
+[MIT](LICENSE)

package/biome.json

@@ -0,0 +1,39 @@
+{
+  "$schema": "https://biomejs.dev/schemas/1.9.3/schema.json",
+  "vcs": {
+    "enabled": true,
+    "clientKind": "git",
+    "useIgnoreFile": true
+  },
+  "files": {
+    "ignoreUnknown": false,
+    "ignore": []
+  },
+  "formatter": {
+    "enabled": true,
+    "indentStyle": "space"
+  },
+  "organizeImports": {
+    "enabled": true
+  },
+  "linter": {
+    "enabled": true,
+    "rules": {
+      "recommended": true,
+      "complexity": {
+        "useLiteralKeys": "off"
+      },
+      "suspicious": {
+        "noExplicitAny": "off"
+      }
+    }
+  },
+  "javascript": {
+    "formatter": {
+      "quoteStyle": "double",
+      "semicolons": "always",
+      "indentStyle": "space",
+      "indentWidth": 2
+    }
+  }
+}

package/cypress/component/solid-boilerplate.cy.ts

@@ -0,0 +1,9 @@
+import { html } from "lit";
+
+describe("<solid-boilerplate>", () => {
+  it("should mount", () => {
+    cy.mount(html`<solid-boilerplate></solid-boilerplate>`);
+
+    cy.get("solid-boilerplate").should("exist");
+  });
+});

package/cypress/cypress.d.ts

@@ -0,0 +1 @@
+/// <reference types="cypress" />

package/cypress/support/component-index.html

@@ -0,0 +1,12 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8" />
+    <meta http-equiv="X-UA-Compatible" content="IE=edge" />
+    <meta name="viewport" content="width=device-width,initial-scale=1.0" />
+    <title>Components App</title>
+  </head>
+  <body>
+    <div data-cy-root></div>
+  </body>
+</html>

package/cypress/support/component.ts

@@ -0,0 +1,17 @@
+import { mount } from "cypress-ct-lit";
+import "/src/index.ts";
+
+declare global {
+  namespace Cypress {
+    interface Chainable {
+      /**
+       * Mount your template/component into Cypress sandbox
+       * @param template
+       * @param options render options for custom rendering
+       */
+      mount: typeof mount;
+    }
+  }
+}
+
+Cypress.Commands.add("mount", mount);

package/cypress.config.ts

@@ -0,0 +1,11 @@
+import { defineConfig } from "cypress";
+
+export default defineConfig({
+  component: {
+    includeShadowDom: true,
+    devServer: {
+      framework: "cypress-ct-lit",
+      bundler: "vite",
+    },
+  },
+});

package/dist/boilerplate.css

@@ -0,0 +1 @@
+@import"https://fonts.googleapis.com/css2?family=Inter:ital,opsz,wght@0,14..32,100..900;1,14..32,100..900&family=Montserrat:ital,wght@0,100..900;1,100..900&display=swap";:root{--font-family:"Inter",sans-serif;--color-text:#181d27;--color-primary:#001aff;--color-secondary:#001aff;--color-third:#e4f0ff;--color-heading:#181d27;font-family:var(--font-family)}