@canonical/maas-react-components 0.1.0 → 1.0.0

package/README.md

@@ -6,3 +6,47 @@ It contains components that are either specific to, or only used in MAAS. Genera
 [@canonical/react-components](https://github.com/canonical/react-components) instead.
 
 Read more in [Project philosophy and guidelines](GUIDELINES.md).
+
+## Getting started
+
+### Installation
+
+```bash
+npm install @canonical/maas-react-components
+```
+
+or using yarn:
+  
+```bash
+yarn add @canonical/maas-react-components
+```
+
+Add styles import to your app:
+
+```css
+@import "@canonical/maas-react-components/dist/style.css";
+```
+
+## Development with `maas-react-components`
+
+To see the changes you make to `maas-react-components` reflected in a consuming app immediately, follow these steps:
+
+1. In the `maas-react-components` directory, run the following command to create a symlink:
+
+   ```bash
+   yarn link
+   ```
+
+2. In the consuming repository (e.g., `maas-ui`), run the following command to use the local version of `maas-react-components`:
+
+   ```bash
+   yarn link "@canonical/maas-react-components"
+   ```
+
+3. Go back to `maas-react-components` directory and run the following command to start the build process with the watch flag:
+
+   ```bash
+   npm run build:watch
+   ```
+
+4. As you make changes to `maas-react-components` they will be automatically built and reflected in the consuming app.

package/package.json

@@ -1,44 +1,86 @@
 {
   "name": "@canonical/maas-react-components",
   "description": "React components for use in MAAS UI projects.",
-  "version": "0.1.0",
+  "version": "1.0.0",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/canonical/maas-react-components.git"
+    "url": "https://github.com/canonical/maas-react-components.git"
   },
   "bugs": {
     "url": "https://github.com/canonical/maas-react-components/issues"
   },
   "homepage": "https://github.com/canonical/maas-react-components#readme",
-  "main": "src/lib/index.ts",
+  "main": "./dist/@canonical/maas-react-components.umd.js",
+  "module": "./dist/@canonical/maas-react-components.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/@canonical/maas-react-components.es.js",
+      "require": "./dist/@canonical/maas-react-components.umd.js"
+    },
+    "./dist/style.css": {
+      "import": "./dist/style.css",
+      "require": "./dist/style.css"
+    }
+  },
   "files": [
-    "dist/**/*"
+    "dist"
   ],
   "license": "AGPL-3.0",
   "scripts": {
     "prepare": "husky install",
     "build": "tsc && vite build",
     "build:watch": "tsc && vite build --watch",
+    "lint": "eslint src && tsc --noEmit",
+    "lint:fix": "eslint --fix src",
+    "format": "prettier --write 'src/**/*.{ts,tsx,css,md,json}' --config ./.prettierrc",
     "test": "vitest run",
     "test:ui": "vitest --ui",
-    "test:watch": "vitest"
+    "test:watch": "vitest",
+    "semantic-release": "semantic-release",
+    "semantic-release-dry-run": "semantic-release --dry-run --no-ci"
   },
   "devDependencies": {
     "@commitlint/cli": "^17.7.1",
     "@commitlint/config-conventional": "^17.7.0",
+    "@semantic-release/changelog": "^6.0.3",
+    "@semantic-release/git": "^10.0.1",
     "@testing-library/jest-dom": "^6.1.3",
     "@testing-library/react": "^14.0.0",
     "@testing-library/user-event": "^14.5.1",
+    "@types/react-dom": "18.2.7",
+    "@typescript-eslint/eslint-plugin": "^6.7.3",
+    "@typescript-eslint/parser": "^6.7.3",
     "@vitejs/plugin-react": "^4.1.0",
+    "eslint": "^8.50.0",
+    "eslint-config-prettier": "^9.0.0",
+    "eslint-import-resolver-typescript": "^3.6.1",
+    "eslint-plugin-import": "^2.28.1",
+    "eslint-plugin-jsx-a11y": "^6.7.1",
+    "eslint-plugin-no-relative-import-paths": "^1.5.2",
+    "eslint-plugin-prettier": "^5.0.0",
+    "eslint-plugin-react": "^7.33.2",
+    "eslint-plugin-react-hooks": "^4.6.0",
+    "eslint-plugin-unused-imports": "^3.0.0",
     "husky": "8.0.0",
+    "prettier": "^3.0.3",
     "sass": "^1.68.0",
+    "semantic-release": "^22.0.5",
     "vite": "^4.4.9",
     "vite-plugin-dts": "^3.6.0",
     "vitest": "^0.34.5"
   },
-  "dependencies": {
-    "react": "^18.2.0",
-    "react-dom": "^18.2.0",
+  "resolutions": {
+    "@types/react": "18.2.14",
+    "@types/react-dom": "18.2.6"
+  },
+  "peerDependencies": {
+    "@canonical/react-components": "^0.47.0",
+    "@types/react": "^17.0.2 || ^18.0.0",
+    "@types/react-dom": "^17.0.2 || ^18.0.0",
+    "react": "18.2.0",
+    "react-dom": "18.2.0",
     "vanilla-framework": "^4.3.0"
   }
 }

package/dist/@canonical/maas-react-components.es.d.ts

@@ -1 +0,0 @@
-export * from '../src/lib/index'

package/dist/@canonical/maas-react-components.es.js

@@ -1 +0,0 @@
-

package/dist/@canonical/maas-react-components.umd.js

@@ -1 +0,0 @@
-(function(n){typeof define=="function"&&define.amd?define(n):n()})(function(){"use strict"});

package/dist/vite.config.d.ts

@@ -1,2 +0,0 @@
-declare const _default: import("vite").UserConfig;
-export default _default;