Merge pull request #2 from kitconcept/rename-frontend-package

Rename frontend package to @kitconcept/volto-keywordmanager

Author: ericof

frontend/.eslintrc.js

@@ -29,7 +29,7 @@ module.exports = {
           ['@plone/volto-slate', `${coreLocation}/packages/volto-slate/src`],
           ['@plone/registry', `${coreLocation}/packages/registry/src`],
           [
-            'volto-keywordmanager',
+            '@kitconcept/volto-keywordmanager',
             `${projectRootPath}/packages/volto-keywordmanager/src`,
           ],
           ...addonAliases,

frontend/Dockerfile

@@ -25,7 +25,7 @@ FROM plone/frontend-prod-config:${VOLTO_VERSION}
 
 LABEL maintainer="kitconcept GmbH <info@kitconcept.com>" \
       org.label-schema.name="kitconcept-keywordmanager-frontend" \
-      org.label-schema.description="kitconcept-keywordmanager frontend image." \
+      org.label-schema.description="@kitconcept/volto-keywordmanager frontend image." \
       org.label-schema.vendor="kitconcept GmbH"
 
 COPY --from=builder /app/ /app/

frontend/README.md

@@ -1,9 +1,9 @@
-# kitconcept-keywordmanager (volto-keywordmanager)
+# Keyword Manager (@kitconcept/volto-keywordmanager)
 
 Change, merge and delete keywords (subjects) in Plone.
 
-[![npm](https://img.shields.io/npm/v/volto-keywordmanager)](https://www.npmjs.com/package/volto-keywordmanager)
-[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook&logoColor=white&style=flat-square)](https://kitconcept.github.io/volto-keywordmanager/)
+[![npm](https://img.shields.io/npm/v/@kitconcept/volto-keywordmanager)](https://www.npmjs.com/package/@kitconcept/volto-keywordmanager)
+[![](https://img.shields.io/badge/-Storybook-ff4785?logo=Storybook&logoColor=white&style=flat-square)](https://kitconcept.github.io/kitconcept-keywordmanager/)
 [![CI](https://github.com/kitconcept/kitconcept-keywordmanager/actions/workflows/main.yml/badge.svg)](https://github.com/kitconcept/kitconcept-keywordmanager/actions/workflows/main.yml)
 
 
@@ -18,61 +18,17 @@ To install your project, you must choose the method appropriate to your version
 
 ### Volto 18 and later
 
-Add `volto-keywordmanager` to your `package.json`.
+Add `@kitconcept/volto-keywordmanager` to your `package.json`.
 
 ```json
-"dependencies": {
-    "volto-keywordmanager": "*"
-}
-```
-
-Add `volto-keywordmanager` to your `volto.config.js`.
-
-```javascript
-const addons = ['volto-keywordmanager'];
-```
-
-If this package provides a Volto theme, and you want to activate it, then add the following to your `volto.config.js`.
-
-```javascript
-const theme = 'volto-keywordmanager';
-```
-
-### Volto 17 and earlier
-
-Create a new Volto project.
-You can skip this step if you already have one.
-
-```
-npm install -g yo @plone/generator-volto
-yo @plone/volto my-volto-project --addon volto-keywordmanager
-cd my-volto-project
-```
-
-Add `volto-keywordmanager` to your `package.json`.
-
-```JSON
 "addons": [
-    "volto-keywordmanager"
+    "@kitconcept/volto-keywordmanager"
 ],
-
 "dependencies": {
-    "volto-keywordmanager": "*"
+    "@kitconcept/volto-keywordmanager": "*"
 }
 ```
 
-Download and install the new add-on.
-
-```
-yarn install
-```
-
-Start Volto.
-
-```
-yarn start
-```
-
 ## Test installation
 
 Visit http://localhost:3000/ in a browser, login, and check the awesome new features.

frontend/package.json

@@ -17,26 +17,26 @@
     "start:prod": "pnpm --filter @plone/volto start:prod",
     "build": "VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto build",
     "build:deps": "pnpm --filter @plone/registry --filter @plone/components build",
-    "i18n": "pnpm --filter volto-keywordmanager i18n && VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto i18n",
-    "test": "pnpm --filter volto-keywordmanager exec vitest",
+    "i18n": "pnpm --filter @kitconcept/volto-keywordmanager i18n && VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto i18n",
+    "test": "pnpm --filter @kitconcept/volto-keywordmanager exec vitest",
     "lint": "VOLTOCONFIG=$(pwd)/volto.config.js eslint --max-warnings=0 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
     "lint:fix": "VOLTOCONFIG=$(pwd)/volto.config.js eslint --fix 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
     "prettier": "prettier --check 'packages/**/src/**/*.{js,jsx,ts,tsx}'",
     "prettier:fix": "prettier --write 'packages/**/src/**/*.{js,jsx,ts,tsx}' ",
     "stylelint": "stylelint 'packages/**/src/**/*.{css,scss,less}' --allow-empty-input",
     "stylelint:fix": "stylelint 'packages/**/src/**/*.{css,scss,less}' --fix --allow-empty-input",
-    "dry-release": "pnpm --filter volto-keywordmanager dry-release",
-    "release": "pnpm --filter volto-keywordmanager release",
-    "release-major-alpha": "pnpm --filter volto-keywordmanager release-major-alpha",
-    "release-alpha": "pnpm --filter volto-keywordmanager release-alpha",
+    "dry-release": "pnpm --filter @kitconcept/volto-keywordmanager dry-release",
+    "release": "pnpm --filter @kitconcept/volto-keywordmanager release",
+    "release-major-alpha": "pnpm --filter @kitconcept/volto-keywordmanager release-major-alpha",
+    "release-alpha": "pnpm --filter @kitconcept/volto-keywordmanager release-alpha",
     "storybook": "VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto storybook dev -p 6006 -c $(pwd)/.storybook",
     "storybook-build": "VOLTOCONFIG=$(pwd)/volto.config.js pnpm --filter @plone/volto build-storybook -c $(pwd)/.storybook"
   },
   "dependencies": {
     "@kitconcept/volto-light-theme": "^8.0.0-alpha.29",
     "@plone/registry": "workspace:*",
     "@plone/volto": "workspace:*",
-    "volto-keywordmanager": "workspace:*"
+    "@kitconcept/volto-keywordmanager": "workspace:*"
   },
   "devDependencies": {
     "mrs-developer": "^2.2.0"

frontend/packages/volto-keywordmanager/.release-it.json

@@ -4,8 +4,8 @@
   },
   "hooks": {
     "after:bump": [
-      "pipx run towncrier build --draft --yes --version ${version} > .changelog.draft",
-      "pipx run towncrier build --yes --version ${version}",
+      "uvx towncrier build --draft --yes --version ${version} > .changelog.draft",
+      "uvx towncrier build --yes --version ${version}",
       "cp ../../README.md ./ && cp CHANGELOG.md ../../CHANGELOG.md",
       "python3 -c 'import json; data = json.load(open(\"../../package.json\")); data[\"version\"] = \"${version}\"; json.dump(data, open(\"../../package.json\", \"w\"), indent=2)'",
       "git add ../../CHANGELOG.md ../../package.json"
@@ -19,7 +19,7 @@
     "publish": false
   },
   "git": {
-    "changelog": "pipx run towncrier build --draft --yes --version 0.0.0",
+    "changelog": "uvx towncrier build --draft --yes --version 0.0.0",
     "requireUpstream": false,
     "requireCleanWorkingDir": false,
     "commitMessage": "Release ${version}",

frontend/packages/volto-keywordmanager/news/+rename-package.internal

@@ -0,0 +1 @@
+Renamed the frontend package from `volto-keywordmanager` to `@kitconcept/volto-keywordmanager`. @ericof

frontend/packages/volto-keywordmanager/package.json

@@ -1,5 +1,5 @@
 {
-  "name": "volto-keywordmanager",
+  "name": "@kitconcept/volto-keywordmanager",
   "version": "1.0.0-alpha.0",
   "description": "Change, merge and delete keywords (subjects) in Plone.",
   "main": "src/index.ts",

frontend/packages/volto-keywordmanager/src/actions/keywordIndexes.ts

@@ -1,4 +1,4 @@
-import { GET_KEYWORD_INDEXES } from 'volto-keywordmanager/constants/KeywordIndexes';
+import { GET_KEYWORD_INDEXES } from '@kitconcept/volto-keywordmanager/constants/KeywordIndexes';
 
 export function getKeywordIndexes() {
   return {

frontend/packages/volto-keywordmanager/src/actions/keywords.ts

@@ -1,6 +1,6 @@
-import { GET_KEYWORDS } from 'volto-keywordmanager/constants/Keywords';
-import { UPDATE_KEYWORDS } from 'volto-keywordmanager/constants/Keywords';
-import { DELETE_KEYWORDS } from 'volto-keywordmanager/constants/Keywords';
+import { GET_KEYWORDS } from '@kitconcept/volto-keywordmanager/constants/Keywords';
+import { UPDATE_KEYWORDS } from '@kitconcept/volto-keywordmanager/constants/Keywords';
+import { DELETE_KEYWORDS } from '@kitconcept/volto-keywordmanager/constants/Keywords';
 
 export function getKeywords({
   index = null,

frontend/packages/volto-keywordmanager/src/components/KeywordManager.tsx

@@ -16,8 +16,8 @@ import {
   getKeywords,
   deleteKeywords,
   updateKeywords,
-} from 'volto-keywordmanager/actions/keywords';
-import { getKeywordIndexes } from 'volto-keywordmanager/actions/keywordIndexes';
+} from '@kitconcept/volto-keywordmanager/actions/keywords';
+import { getKeywordIndexes } from '@kitconcept/volto-keywordmanager/actions/keywordIndexes';
 import UniversalLink from '@plone/volto/components/manage/UniversalLink/UniversalLink';
 import RenameModal from './RenameModal';
 import DeleteModal from './DeleteModal';