From d30993f222f98ada16b6dc625e9e6ff92d8ef2ee Mon Sep 17 00:00:00 2001 From: Jonathan Carle Date: Tue, 19 Dec 2023 10:59:16 +0100 Subject: [PATCH 1/7] Rebranding: Update working title to actual title Updated package names to match. --- .changeset/pre.json | 4 ++-- .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/config.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/workflows/check.yml | 18 ++++++++--------- .github/workflows/deploy.yml | 10 +++++----- .github/workflows/prerelease.yml | 2 +- CONTRIBUTING.md | 10 +++++----- README.md | 6 +++--- apps/docs/.cloud-foundry/manifest-dev.yml | 2 +- apps/docs/src/.vitepress/config.ts | 6 +++--- apps/docs/src/.vitepress/utils.ts | 6 ++++-- apps/docs/src/getting-started.md | 19 +++++++++--------- apps/docs/src/index.md | 10 +++++----- apps/docs/src/team.md | 8 +++----- .../.cloud-foundry/Staticfile | 0 .../.cloud-foundry/manifest-dev.yml | 2 +- packages/{nui => components}/.eslintrc.cjs | 0 .../.storybook/docs-template.mdx | 0 .../.storybook/docs-template.scss | 0 .../{nui => components}/.storybook/main.ts | 0 .../{nui => components}/.storybook/mdx.d.ts | 0 .../{nui => components}/.storybook/preview.ts | 2 +- packages/{nui => components}/README.md | 20 +++++++++---------- packages/{nui => components}/env.d.ts | 0 packages/{nui => components}/package.json | 10 +++++----- .../{nui => components}/playwright.config.ts | 0 .../{nui => components}/playwright/index.html | 0 .../{nui => components}/playwright/index.ts | 0 .../components/TestInput/TestInput.spec.tsx | 0 .../components/TestInput/TestInput.stories.ts | 2 +- .../src/components/TestInput/TestInput.vue | 0 packages/{nui => components}/src/index.ts | 0 .../{nui => components}/src/styles/index.scss | 0 .../{nui => components}/tsconfig.app.json | 0 packages/{nui => components}/tsconfig.json | 0 .../{nui => components}/tsconfig.node.json | 0 .../{nui => components}/tsconfig.vitest.json | 0 packages/{nui => components}/vite.config.ts | 0 packages/storybook-utils/package.json | 2 +- packages/storybook-utils/src/actions.ts | 2 +- packages/storybook-utils/src/preview.ts | 2 +- pnpm-lock.yaml | 4 ++-- 43 files changed, 76 insertions(+), 77 deletions(-) rename packages/{nui => components}/.cloud-foundry/Staticfile (100%) rename packages/{nui => components}/.cloud-foundry/manifest-dev.yml (77%) rename packages/{nui => components}/.eslintrc.cjs (100%) rename packages/{nui => components}/.storybook/docs-template.mdx (100%) rename packages/{nui => components}/.storybook/docs-template.scss (100%) rename packages/{nui => components}/.storybook/main.ts (100%) rename packages/{nui => components}/.storybook/mdx.d.ts (100%) rename packages/{nui => components}/.storybook/preview.ts (91%) rename packages/{nui => components}/README.md (63%) rename packages/{nui => components}/env.d.ts (100%) rename packages/{nui => components}/package.json (85%) rename packages/{nui => components}/playwright.config.ts (100%) rename packages/{nui => components}/playwright/index.html (100%) rename packages/{nui => components}/playwright/index.ts (100%) rename packages/{nui => components}/src/components/TestInput/TestInput.spec.tsx (100%) rename packages/{nui => components}/src/components/TestInput/TestInput.stories.ts (91%) rename packages/{nui => components}/src/components/TestInput/TestInput.vue (100%) rename packages/{nui => components}/src/index.ts (100%) rename packages/{nui => components}/src/styles/index.scss (100%) rename packages/{nui => components}/tsconfig.app.json (100%) rename packages/{nui => components}/tsconfig.json (100%) rename packages/{nui => components}/tsconfig.node.json (100%) rename packages/{nui => components}/tsconfig.vitest.json (100%) rename packages/{nui => components}/vite.config.ts (100%) diff --git a/.changeset/pre.json b/.changeset/pre.json index eae5283386..5b4df2d12a 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -2,8 +2,8 @@ "mode": "pre", "tag": "alpha", "initialVersions": { - "@temp-nui/nui": "0.0.0", - "@temp-nui/storybook-utils": "0.0.0" + "@sit-onyx/components": "0.0.0", + "@sit-onyx/storybook-utils": "0.0.0" }, "changesets": [] } diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index 2a90f4b501..c7c972088b 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,5 +1,5 @@ name: Report a bug 🐞 -description: You found a bug in NUI? You can report it with the form below. +description: You found a bug in Onyx? You can report it with the form below. title: "[Bug]: " labels: - bug diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index fb015ad4ea..dacaa23be2 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,5 +1,5 @@ blank_issues_enabled: false contact_links: - name: Questions & Discussions - url: https://github.com/schwarzit/nui/discussions/categories/q-a + url: https://github.com/schwarzit/onyx/discussions/categories/q-a about: You have a question that might already be answered by the community? Take a look at the GitHub discussions! diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index dfb3602cdb..6d3aafc994 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,6 @@ name: Request a new feature 🚀 description: >- - Do you want to request a new feature to be added to NUI? You can request it + Do you want to request a new feature to be added to Onyx? You can request it with the form below. title: "[Feature request]: " labels: diff --git a/.github/workflows/check.yml b/.github/workflows/check.yml index 2e29871362..60b86e3a74 100644 --- a/.github/workflows/check.yml +++ b/.github/workflows/check.yml @@ -29,11 +29,11 @@ jobs: - name: 🛠️ Build run: pnpm run build - working-directory: packages/nui + working-directory: packages/components - name: 🛠️ Build Storybook run: pnpm run build:storybook - working-directory: packages/nui + working-directory: packages/components - name: 🛠️ Build documentation run: pnpm run build @@ -41,17 +41,17 @@ jobs: - name: 🚨 Run unit tests run: pnpm run test:unit:coverage - working-directory: packages/nui + working-directory: packages/components # install system dependencies for Playwright # see: https://playwright.dev/python/docs/browsers#install-system-dependencies - name: 📦 Install Playwright system dependencies run: pnpm exec playwright install-deps - working-directory: packages/nui + working-directory: packages/components - name: 🚨 Run component tests run: pnpm run test:components - working-directory: packages/nui + working-directory: packages/components - name: Run publint run: pnpm run publint @@ -66,15 +66,15 @@ jobs: with: name: test-results path: | - packages/nui/coverage - packages/nui/playwright-report - packages/nui/test-results + packages/components/coverage + packages/components/playwright-report + packages/components/test-results - name: Upload Storybook artifact uses: actions/upload-artifact@v3 with: name: storybook-static - path: packages/nui/storybook-static + path: packages/components/storybook-static - name: Upload documentation artifact uses: actions/upload-artifact@v3 diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index e57e53a09d..6f90941e43 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -4,7 +4,7 @@ on: branches: - main paths: - - "packages/nui/**" + - "packages/components/**" workflow_dispatch: inputs: stage: @@ -35,7 +35,7 @@ jobs: - name: 🛠️ Build Storybook run: pnpm run build:storybook - working-directory: packages/nui + working-directory: packages/components - name: 🛠️ Build documentation run: pnpm run build @@ -45,7 +45,7 @@ jobs: uses: actions/upload-artifact@v3 with: name: storybook-static - path: packages/nui/storybook-static + path: packages/components/storybook-static - name: Upload documentation artifact uses: actions/upload-artifact@v3 @@ -64,7 +64,7 @@ jobs: uses: actions/download-artifact@v3 with: name: storybook-static - path: packages/nui/.cloud-foundry/storybook-static + path: packages/components/.cloud-foundry/storybook-static - name: Deploy to Cloud Foundry uses: ./.github/templates/cf-push @@ -77,7 +77,7 @@ jobs: # is only assigned when the workflow is triggered manually. When triggered e.g. on push # the input will be unset so a fallback is needed here cf-space: ${{ inputs.stage || 'dev' }} - working-directory: packages/nui/.cloud-foundry + working-directory: packages/components/.cloud-foundry deploy_documentation: name: Deploy documentation diff --git a/.github/workflows/prerelease.yml b/.github/workflows/prerelease.yml index f30f6024b9..b1da68fbd3 100644 --- a/.github/workflows/prerelease.yml +++ b/.github/workflows/prerelease.yml @@ -21,7 +21,7 @@ jobs: node-version-file: .node-version cache: pnpm registry-url: "https://registry.npmjs.org/" - scope: temp-nui + scope: sit-onyx env: NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d496ec4dd7..c45933aea3 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,4 +1,4 @@ -# NUI Contributing Guide +# Onyx Contributing Guide ## Prerequisites / Technical setup @@ -26,9 +26,9 @@ TypeScript cannot handle type information for `.vue` imports by default. In VS C Pull Requests are very welcome! -1. You will need to [create a fork](https://github.com/larsrickert/temp-nui/fork) to commit and push your changes to. +1. You will need to [create a fork](https://github.com/SchwarzIT/onyx/fork) to commit and push your changes to. 2. When your changes affect the user you need to [add a changeset](./.changeset/README.md). -3. Then [create a PR](https://github.com/larsrickert/temp-nui/compare) to merge your changes back into our repository. +3. Then [create a PR](https://github.com/SchwarzIT/onyx/compare) to merge your changes back into our repository. ## Scripts @@ -56,9 +56,9 @@ pnpm run format
-### NUI +### Onyx -The following scripts are available inside [`packages/nui`](packages/nui): +The following scripts are available inside [`packages/components`](packages/components): #### Type-Check, Compile and Minify for Production diff --git a/README.md b/README.md index 5c6da7c70e..7d7d353b79 100644 --- a/README.md +++ b/README.md @@ -6,11 +6,11 @@

-# NUI +# Onyx -A Vue.js UI component library and Design System created by [Schwarz IT](https://it.schwarz). +A Design System and Vue.js UI component library created by [Schwarz IT](https://it.schwarz). -> **Work in progress**: This library is currently in early / active development.
**Working title**: The name `NUI` is only a working title and will be changed in the future. +> **Work in progress**: This library is currently in early / active development.

diff --git a/apps/docs/.cloud-foundry/manifest-dev.yml b/apps/docs/.cloud-foundry/manifest-dev.yml index 2cf70d8299..9149d620f7 100644 --- a/apps/docs/.cloud-foundry/manifest-dev.yml +++ b/apps/docs/.cloud-foundry/manifest-dev.yml @@ -1,5 +1,5 @@ --- applications: - - name: nui-documentation-dev + - name: onyx-documentation-dev memory: 64M buildpack: https://github.com/cloudfoundry/staticfile-buildpack diff --git a/apps/docs/src/.vitepress/config.ts b/apps/docs/src/.vitepress/config.ts index 6c2ac6c382..29a0a4eed1 100644 --- a/apps/docs/src/.vitepress/config.ts +++ b/apps/docs/src/.vitepress/config.ts @@ -1,10 +1,10 @@ import { defineConfig } from "vitepress"; -import packageJson from "../../../../packages/nui/package.json"; +import packageJson from "../../../../packages/components/package.json"; import { getComponents } from "./utils"; // https://vitepress.dev/reference/site-config export default defineConfig({ - title: "NUI", + title: "Onyx", description: "Vue.js component library and design system", themeConfig: { externalLinkIcon: true, @@ -26,7 +26,7 @@ export default defineConfig({ nav: [ { text: "Getting Started", link: "/getting-started" }, { text: "Report a bug", link: packageJson.bugs.url }, - { text: "Q&A", link: "https://github.com/schwarzit/nui/discussions/categories/q-a" }, + { text: "Q&A", link: "https://github.com/schwarzit/onyx/discussions/categories/q-a" }, ], socialLinks: [{ icon: "github", link: packageJson.repository.url }], sidebar: [ diff --git a/apps/docs/src/.vitepress/utils.ts b/apps/docs/src/.vitepress/utils.ts index 75d474bcba..ca90f99d2a 100644 --- a/apps/docs/src/.vitepress/utils.ts +++ b/apps/docs/src/.vitepress/utils.ts @@ -2,9 +2,11 @@ import fs from "node:fs"; import { fileURLToPath } from "node:url"; /** - * Gets a list of all available NUI component names. + * Gets a list of all available Onyx component names. */ export const getComponents = () => { - const path = fileURLToPath(new URL("../../../../packages/nui/src/components", import.meta.url)); + const path = fileURLToPath( + new URL("../../../../packages/components/src/components", import.meta.url), + ); return fs.readdirSync(path); }; diff --git a/apps/docs/src/getting-started.md b/apps/docs/src/getting-started.md index 486256afaa..bfd77bc703 100644 --- a/apps/docs/src/getting-started.md +++ b/apps/docs/src/getting-started.md @@ -2,14 +2,13 @@ ::: warning Work in progress / Active development This library is currently in early / active development. -The name `NUI` is only a working title and will be changed in the future. ::: ## Installation Install the npm package with your corresponding package manager: @@ -17,15 +16,15 @@ Install the npm package with your corresponding package manager: ::: code-group ```sh [pnpm] -pnpm add nui +pnpm add @sit-onyx/components ``` ```sh [npm] -npm install nui +npm install @sit-onyx/components ``` ```sh [yarn] -yarn install nui +yarn install @sit-onyx/components ``` ::: @@ -35,9 +34,9 @@ After that, import the global CSS file: ::: code-group ```ts [main.ts] -import "nui/style.css"; -// if you override some NUI styles (e.g. CSS variables), -// make sure to import your custom CSS file after the default "nui/style.css" +import "@sit-onyx/components/style.css"; +// if you override some Onyx styles (e.g. CSS variables), +// make sure to import your custom CSS file after the default "@sit-onyx/components/style.css" ``` ::: @@ -46,10 +45,10 @@ Components are now ready to be used, e.g.: ```vue ``` diff --git a/apps/docs/src/index.md b/apps/docs/src/index.md index edbd5ecdb0..60dffb793b 100644 --- a/apps/docs/src/index.md +++ b/apps/docs/src/index.md @@ -3,7 +3,7 @@ layout: home hero: - name: NUI + name: Onyx text: Design system tagline: A Vue.js component library and design system created by Schwarz IT. image: @@ -16,21 +16,21 @@ hero: features: - title: Powerful - details: NUIs advanced components are designed for enterprise grade applications. Including everything you need to build your next enterprise or even personal project. + details: Onyx's advanced components are designed for enterprise grade applications. Including everything you need to build your next enterprise or even personal project. icon: 🚀 - title: Flexible and modular - details: You can build a whole application with NUI or only use a few of our customizable components into an existing application. + details: You can build a whole application with Onyx or only use a few of our customizable components into an existing application. icon: 📦 - title: Themeable details: We provide a well crafted theme out-of-the-box. Feel free to customize it to perfectly fit your look and feel. icon: 🎨 - title: First class DX - details: Developer Experience is our top priority. NUI is fully written in TypeScript with great type support and generically typed components. + details: Developer Experience is our top priority. Onyx is fully written in TypeScript with great type support and generically typed components. icon: src: /icons/typescript.svg alt: TypeScript logo - title: Figma library - details: NUI also offers a Figma library for design purposes. Connecting Design and Development. + details: Onyx also offers a Figma library for design purposes. Connecting Design and Development. icon: src: /icons/figma.svg alt: Figma logo diff --git a/apps/docs/src/team.md b/apps/docs/src/team.md index a553e76661..79ad61dd32 100644 --- a/apps/docs/src/team.md +++ b/apps/docs/src/team.md @@ -56,11 +56,9 @@ const members = [ # Meet the team 👋 -NUI is maintained by [Schwarz IT](https://it.schwarz). Below you will find the members of our Core Team. +Onyx is maintained by [Schwarz IT](https://it.schwarz). Below you will find the members of our Core Team. -Are you looking for a bug report or feature request? Then please use our [GitHub issues](https://github.com/schwarzit/nui/issues). -For general Q&A, announcements and polls feel free to visit our community space via [GitHub discussions](https://github.com/schwarzit/nui/discussions/categories/q-a). - -For business requests you can [contact Martin Hofmann](mailto:martin.hofmann@mail.schwarz). +Are you looking for a bug report or feature request? Then please use our [GitHub issues](https://github.com/schwarzit/onyx/issues). +For general Q&A, announcements and polls feel free to visit our community space via [GitHub discussions](https://github.com/schwarzit/onyx/discussions/categories/q-a). diff --git a/packages/nui/.cloud-foundry/Staticfile b/packages/components/.cloud-foundry/Staticfile similarity index 100% rename from packages/nui/.cloud-foundry/Staticfile rename to packages/components/.cloud-foundry/Staticfile diff --git a/packages/nui/.cloud-foundry/manifest-dev.yml b/packages/components/.cloud-foundry/manifest-dev.yml similarity index 77% rename from packages/nui/.cloud-foundry/manifest-dev.yml rename to packages/components/.cloud-foundry/manifest-dev.yml index a99a95390d..d2c9d63d52 100644 --- a/packages/nui/.cloud-foundry/manifest-dev.yml +++ b/packages/components/.cloud-foundry/manifest-dev.yml @@ -1,5 +1,5 @@ --- applications: - - name: nui-storybook-dev + - name: onyx-storybook-dev memory: 64M buildpack: https://github.com/cloudfoundry/staticfile-buildpack diff --git a/packages/nui/.eslintrc.cjs b/packages/components/.eslintrc.cjs similarity index 100% rename from packages/nui/.eslintrc.cjs rename to packages/components/.eslintrc.cjs diff --git a/packages/nui/.storybook/docs-template.mdx b/packages/components/.storybook/docs-template.mdx similarity index 100% rename from packages/nui/.storybook/docs-template.mdx rename to packages/components/.storybook/docs-template.mdx diff --git a/packages/nui/.storybook/docs-template.scss b/packages/components/.storybook/docs-template.scss similarity index 100% rename from packages/nui/.storybook/docs-template.scss rename to packages/components/.storybook/docs-template.scss diff --git a/packages/nui/.storybook/main.ts b/packages/components/.storybook/main.ts similarity index 100% rename from packages/nui/.storybook/main.ts rename to packages/components/.storybook/main.ts diff --git a/packages/nui/.storybook/mdx.d.ts b/packages/components/.storybook/mdx.d.ts similarity index 100% rename from packages/nui/.storybook/mdx.d.ts rename to packages/components/.storybook/mdx.d.ts diff --git a/packages/nui/.storybook/preview.ts b/packages/components/.storybook/preview.ts similarity index 91% rename from packages/nui/.storybook/preview.ts rename to packages/components/.storybook/preview.ts index 05f74f18bd..fb379e3cd3 100644 --- a/packages/nui/.storybook/preview.ts +++ b/packages/components/.storybook/preview.ts @@ -1,4 +1,4 @@ -import { createPreview } from "@temp-nui/storybook-utils"; +import { createPreview } from "@sit-onyx/storybook-utils"; import docsTemplate from "./docs-template.mdx"; import "@/styles/index.scss"; diff --git a/packages/nui/README.md b/packages/components/README.md similarity index 63% rename from packages/nui/README.md rename to packages/components/README.md index 88308cdd3c..4dc00be95f 100644 --- a/packages/nui/README.md +++ b/packages/components/README.md @@ -6,11 +6,11 @@

-# NUI +# Onyx A Vue.js UI component library and Design System created by [Schwarz IT](https://it.schwarz). -> **Work in progress**: This library is currently in early / active development.
**Working title**: The name `NUI` is only a working title and will be changed in the future. +> **Work in progress**: This library is currently in early / active development.
@@ -21,38 +21,38 @@ Install the npm package with your corresponding package manager: ### pnpm ```sh -pnpm add nui +pnpm add @sit-onyx/components ``` ### npm ```sh -npm install nui +npm install @sit-onyx/components ``` ### yarn ```sh -yarn install nui +yarn install @sit-onyx/components ``` After that, import the global CSS file in your `main.ts` file: ```ts -import "nui/style.css"; -// if you override some NUI styles (e.g. CSS variables), -// make sure to import your custom CSS file after the default "nui/style.css" +import "@sit-onyx/components/style.css"; +// if you override some Onyx styles (e.g. CSS variables), +// make sure to import your custom CSS file after the default "@sit-onyx/components/style.css" ``` Components are now ready to be used, e.g.: ```vue ``` diff --git a/packages/nui/env.d.ts b/packages/components/env.d.ts similarity index 100% rename from packages/nui/env.d.ts rename to packages/components/env.d.ts diff --git a/packages/nui/package.json b/packages/components/package.json similarity index 85% rename from packages/nui/package.json rename to packages/components/package.json index 6409d5b44a..3ea76d2780 100644 --- a/packages/nui/package.json +++ b/packages/components/package.json @@ -1,5 +1,5 @@ { - "name": "@temp-nui/nui", + "name": "@sit-onyx/components", "description": "A Vue.js UI component library and Design System created by Schwarz IT", "version": "0.0.0", "type": "module", @@ -17,11 +17,11 @@ }, "repository": { "type": "git", - "url": "https://github.com/schwarzit/nui", - "directory": "packages/nui" + "url": "https://github.com/schwarzit/onx", + "directory": "packages/components" }, "bugs": { - "url": "https://github.com/schwarzit/nui/issues" + "url": "https://github.com/schwarzit/onyx/issues" }, "scripts": { "dev": "storybook dev -p 6006 --no-open", @@ -38,7 +38,7 @@ "vue": ">= 3" }, "devDependencies": { - "@temp-nui/storybook-utils": "workspace:^", + "@sit-onyx/storybook-utils": "workspace:^", "@playwright/experimental-ct-vue": "^1.40.1", "@playwright/test": "^1.40.1", "@storybook/addon-essentials": "^7.6.4", diff --git a/packages/nui/playwright.config.ts b/packages/components/playwright.config.ts similarity index 100% rename from packages/nui/playwright.config.ts rename to packages/components/playwright.config.ts diff --git a/packages/nui/playwright/index.html b/packages/components/playwright/index.html similarity index 100% rename from packages/nui/playwright/index.html rename to packages/components/playwright/index.html diff --git a/packages/nui/playwright/index.ts b/packages/components/playwright/index.ts similarity index 100% rename from packages/nui/playwright/index.ts rename to packages/components/playwright/index.ts diff --git a/packages/nui/src/components/TestInput/TestInput.spec.tsx b/packages/components/src/components/TestInput/TestInput.spec.tsx similarity index 100% rename from packages/nui/src/components/TestInput/TestInput.spec.tsx rename to packages/components/src/components/TestInput/TestInput.spec.tsx diff --git a/packages/nui/src/components/TestInput/TestInput.stories.ts b/packages/components/src/components/TestInput/TestInput.stories.ts similarity index 91% rename from packages/nui/src/components/TestInput/TestInput.stories.ts rename to packages/components/src/components/TestInput/TestInput.stories.ts index 348f2687e9..04fc674be7 100644 --- a/packages/nui/src/components/TestInput/TestInput.stories.ts +++ b/packages/components/src/components/TestInput/TestInput.stories.ts @@ -1,4 +1,4 @@ -import { defineStorybookActionsAndVModels } from "@temp-nui/storybook-utils"; +import { defineStorybookActionsAndVModels } from "@sit-onyx/storybook-utils"; import type { Meta, StoryObj } from "@storybook/vue3"; import TestInput from "./TestInput.vue"; diff --git a/packages/nui/src/components/TestInput/TestInput.vue b/packages/components/src/components/TestInput/TestInput.vue similarity index 100% rename from packages/nui/src/components/TestInput/TestInput.vue rename to packages/components/src/components/TestInput/TestInput.vue diff --git a/packages/nui/src/index.ts b/packages/components/src/index.ts similarity index 100% rename from packages/nui/src/index.ts rename to packages/components/src/index.ts diff --git a/packages/nui/src/styles/index.scss b/packages/components/src/styles/index.scss similarity index 100% rename from packages/nui/src/styles/index.scss rename to packages/components/src/styles/index.scss diff --git a/packages/nui/tsconfig.app.json b/packages/components/tsconfig.app.json similarity index 100% rename from packages/nui/tsconfig.app.json rename to packages/components/tsconfig.app.json diff --git a/packages/nui/tsconfig.json b/packages/components/tsconfig.json similarity index 100% rename from packages/nui/tsconfig.json rename to packages/components/tsconfig.json diff --git a/packages/nui/tsconfig.node.json b/packages/components/tsconfig.node.json similarity index 100% rename from packages/nui/tsconfig.node.json rename to packages/components/tsconfig.node.json diff --git a/packages/nui/tsconfig.vitest.json b/packages/components/tsconfig.vitest.json similarity index 100% rename from packages/nui/tsconfig.vitest.json rename to packages/components/tsconfig.vitest.json diff --git a/packages/nui/vite.config.ts b/packages/components/vite.config.ts similarity index 100% rename from packages/nui/vite.config.ts rename to packages/components/vite.config.ts diff --git a/packages/storybook-utils/package.json b/packages/storybook-utils/package.json index 5f875eb185..55387a2ee2 100644 --- a/packages/storybook-utils/package.json +++ b/packages/storybook-utils/package.json @@ -1,5 +1,5 @@ { - "name": "@temp-nui/storybook-utils", + "name": "@sit-onyx/storybook-utils", "description": "Storybook utilities for Vue", "version": "0.0.0", "type": "module", diff --git a/packages/storybook-utils/src/actions.ts b/packages/storybook-utils/src/actions.ts index d092f5b25b..d951664f46 100644 --- a/packages/storybook-utils/src/actions.ts +++ b/packages/storybook-utils/src/actions.ts @@ -11,7 +11,7 @@ import type { DefineStorybookActionsAndVModelsOptions, ExtractVueEventNames } fr * @example * ```ts * // Input.stories.ts - * import { defineStorybookActionsAndVModels } from '@temp-nui/storybook-utils'; + * import { defineStorybookActionsAndVModels } from '@sit-onyx/storybook-utils'; * import type { Meta } from '@storybook/vue3'; * import Input from './Input.vue'; * diff --git a/packages/storybook-utils/src/preview.ts b/packages/storybook-utils/src/preview.ts index 5ba1f0be78..323268e30b 100644 --- a/packages/storybook-utils/src/preview.ts +++ b/packages/storybook-utils/src/preview.ts @@ -6,7 +6,7 @@ import { deepmerge } from "deepmerge-ts"; import { DARK_MODE_EVENT_NAME } from "storybook-dark-mode"; /** - * Creates a default Storybook preview configuration for NUI with the following features: + * Creates a default Storybook preview configuration for 'Onyx' with the following features: * - Improved controls (sorting and expanded controls so descriptions etc. are also shown in a single story) * - Improved Vue-specific code highlighting (e.g. using `@` instead of `v-on:`) * - Setup for dark mode (including docs page). Requires addon `storybook-dark-mode` to be enabled in .storybook/main.ts file diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index d167b65e37..71589b62dc 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -87,7 +87,7 @@ importers: specifier: ^1.0.0-rc.31 version: 1.0.0-rc.31(@algolia/client-search@4.21.0)(@types/node@20.10.4)(sass@1.69.5)(search-insights@2.13.0)(typescript@5.3.3) - packages/nui: + packages/components: dependencies: vue: specifier: '>= 3' @@ -111,7 +111,7 @@ importers: '@storybook/vue3-vite': specifier: ^7.6.4 version: 7.6.4(@vue/compiler-core@3.3.11)(typescript@5.3.3)(vite@5.0.7)(vue@3.3.11) - '@temp-nui/storybook-utils': + '@sit-onyx/storybook-utils': specifier: workspace:^ version: link:../storybook-utils '@vue/compiler-dom': From f08f8a01eb621fa6765dcc506ee9cdc61a6527e6 Mon Sep 17 00:00:00 2001 From: Jonathan Date: Tue, 19 Dec 2023 14:05:48 +0100 Subject: [PATCH 2/7] Update packages/components/package.json Co-authored-by: Lars Rickert --- packages/components/package.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/components/package.json b/packages/components/package.json index 3ea76d2780..6229eeae41 100644 --- a/packages/components/package.json +++ b/packages/components/package.json @@ -17,7 +17,7 @@ }, "repository": { "type": "git", - "url": "https://github.com/schwarzit/onx", + "url": "https://github.com/schwarzit/onyx", "directory": "packages/components" }, "bugs": { From 2ad45b86f97bd4d5fa065c2d01953030b9d00891 Mon Sep 17 00:00:00 2001 From: Jonathan Carle Date: Tue, 19 Dec 2023 14:14:50 +0100 Subject: [PATCH 3/7] update storybook host --- apps/docs/src/.vitepress/env.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/apps/docs/src/.vitepress/env.ts b/apps/docs/src/.vitepress/env.ts index 3799e5d0c4..398c2f2422 100644 --- a/apps/docs/src/.vitepress/env.ts +++ b/apps/docs/src/.vitepress/env.ts @@ -1,5 +1,5 @@ export const vitepressEnv = { storybookHost: import.meta.env.VITE_STORYBOOK_HOST || - "https://nui-storybook-dev.apps.01.cf.eu01.stackit.cloud", + "https://onyx-storybook-dev.apps.01.cf.eu01.stackit.cloud", } as const; From 0d9c002d77ee554564cde15227f3b9dbee346bad Mon Sep 17 00:00:00 2001 From: Jonathan Carle Date: Tue, 19 Dec 2023 14:21:30 +0100 Subject: [PATCH 4/7] rename package @sit-onyx/components to sit-onyx --- .changeset/pre.json | 2 +- apps/docs/src/getting-started.md | 12 ++++++------ packages/components/README.md | 12 ++++++------ packages/components/package.json | 2 +- 4 files changed, 14 insertions(+), 14 deletions(-) diff --git a/.changeset/pre.json b/.changeset/pre.json index 5b4df2d12a..8673befd6e 100644 --- a/.changeset/pre.json +++ b/.changeset/pre.json @@ -2,7 +2,7 @@ "mode": "pre", "tag": "alpha", "initialVersions": { - "@sit-onyx/components": "0.0.0", + "sit-onyx": "0.0.0", "@sit-onyx/storybook-utils": "0.0.0" }, "changesets": [] diff --git a/apps/docs/src/getting-started.md b/apps/docs/src/getting-started.md index bfd77bc703..46b8a22ca4 100644 --- a/apps/docs/src/getting-started.md +++ b/apps/docs/src/getting-started.md @@ -16,15 +16,15 @@ Install the npm package with your corresponding package manager: ::: code-group ```sh [pnpm] -pnpm add @sit-onyx/components +pnpm add sit-onyx ``` ```sh [npm] -npm install @sit-onyx/components +npm install sit-onyx ``` ```sh [yarn] -yarn install @sit-onyx/components +yarn install sit-onyx ``` ::: @@ -34,9 +34,9 @@ After that, import the global CSS file: ::: code-group ```ts [main.ts] -import "@sit-onyx/components/style.css"; +import "sit-onyx/style.css"; // if you override some Onyx styles (e.g. CSS variables), -// make sure to import your custom CSS file after the default "@sit-onyx/components/style.css" +// make sure to import your custom CSS file after the default "sit-onyx/style.css" ``` ::: @@ -45,7 +45,7 @@ Components are now ready to be used, e.g.: ```vue