@tryghost/comments-ui 0.12.3 → 0.13.0

package/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2013-2022 Ghost Foundation
+Copyright (c) 2013-2023 Ghost Foundation
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -1,79 +1,17 @@
-# Comments Ui
+# Comments UI
 
-# Getting Started with Create React App
+Comments widget that is embedded at the bottom of posts in Ghost.
 
-This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app).
+## Development
 
-## Basic Setup
+### Pre-requisites
 
-This section is mostly relevant for core team only for active Comments development.
+- Run `yarn` in Ghost monorepo root
 
-- Run `yarn start:dev` to start Comments in development mode
-- Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
-- To use the local Comments script in a local Ghost site
-    - Update `config.local.json` in Ghost repo to add "comments" config pointing to local dev server url as instructed on terminal.
-    - By default, this uses port `5368` for loading local Comments script on Ghost site. It's also possible to specify a custom port when running the script using - `--port=xxxx`.
-
-## Available Scripts
-
-In the project directory, you can run:
-
-### `yarn test`
-
-Launches the test runner in the interactive watch mode.\
-See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
-
-### `yarn build`
-
-Builds the app for production to the `build` folder.\
-It correctly bundles React in production mode and optimizes the build for the best performance.
-
-The build is minified and the filenames include the hashes.\
-Your app is ready to be deployed!
-
-See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
-
-### `yarn eject`
-
-**Note: this is a one-way operation. Once you `eject`, you can't go back!**
-
-If you aren't satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
-
-Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you're on your own.
-
-You don't have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn't feel obligated to use this feature. However we understand that this tool wouldn't be useful if you couldn't customize it when you are ready for it.
-
-## Learn More
-
-You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
-
-To learn React, check out the [React documentation](https://reactjs.org/).
-
-### Code Splitting
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/code-splitting](https://facebook.github.io/create-react-app/docs/code-splitting)
-
-### Analyzing the Bundle Size
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size](https://facebook.github.io/create-react-app/docs/analyzing-the-bundle-size)
-
-### Making a Progressive Web App
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app](https://facebook.github.io/create-react-app/docs/making-a-progressive-web-app)
-
-### Advanced Configuration
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/advanced-configuration](https://facebook.github.io/create-react-app/docs/advanced-configuration)
-
-### Deployment
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/deployment](https://facebook.github.io/create-react-app/docs/deployment)
-
-### `yarn build` fails to minify
-
-This section has moved here: [https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify](https://facebook.github.io/create-react-app/docs/troubleshooting#npm-run-build-fails-to-minify)
+### Running via Ghost `yarn dev` in root folder
 
+You can automatically start the comments dev server when developing Ghost by running Ghost (in root folder) via `yarn dev --all` or `yarn dev --comments`. This will host the comments JavaScript files, and makes sure that Ghost uses these locally hosted assets instead of the ones from the CDN.
 
 # Copyright & License 
 
-Copyright (c) 2013-2022 Ghost Foundation - Released under the [MIT license](LICENSE).
+Copyright (c) 2013-2023 Ghost Foundation - Released under the [MIT license](LICENSE).

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tryghost/comments-ui",
-  "version": "0.12.3",
+  "version": "0.13.0",
   "license": "MIT",
   "repository": "git@github.com:TryGhost/comments-ui.git",
   "author": "Ghost Foundation",
@@ -14,43 +14,21 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   },
-  "dependencies": {
-    "@headlessui/react": "^1.6.6",
-    "@sentry/react": "^7.5.0",
-    "@tiptap/core": "^2.0.0-beta.182",
-    "@tiptap/extension-blockquote": "^2.0.0-beta.29",
-    "@tiptap/extension-document": "^2.0.0-beta.17",
-    "@tiptap/extension-hard-break": "^2.0.0-beta.33",
-    "@tiptap/extension-link": "^2.0.0-beta.43",
-    "@tiptap/extension-paragraph": "^2.0.0-beta.26",
-    "@tiptap/extension-placeholder": "^2.0.0-beta.53",
-    "@tiptap/extension-text": "^2.0.0-beta.17",
-    "@tiptap/react": "^2.0.0-beta.114",
-    "react": "17.0.2",
-    "react-dom": "17.0.2",
-    "react-scripts": "4.0.3"
-  },
   "scripts": {
-    "start": "PORT=4000 BROWSER=none react-scripts start",
-    "start:combined": "PORT=4000 BROWSER=none node ./scripts/start-combined.js",
-    "start:dev": "PORT=4000 node ./scripts/start-mode.js",
-    "dev": "node ./scripts/dev-mode.js",
-    "build": "npm run build:combined",
-    "build:original": "react-scripts build",
-    "build:combined": "node ./scripts/build-combined.js",
-    "build:bundle": "webpack --config webpack.config.js",
-    "test:ui": "react-scripts test",
-    "test": "yarn test:ui --watchAll=false --coverage",
-    "eject": "react-scripts eject",
-    "lint": "eslint src --ext .js --cache",
+    "dev": "concurrently \"yarn preview --host -l silent\" \"yarn build:watch\"",
+    "dev:test": "vite build && vite preview --port 7175",
+    "build": "vite build",
+    "build:watch": "vite build --watch",
+    "preview": "vite preview",
+    "test": "vitest run --coverage && yarn test:e2e",
+    "test:e2e": "NODE_OPTIONS='--experimental-specifier-resolution=node --no-warnings' VITE_TEST=true playwright test",
+    "test:slowmo": "TIMEOUT=100000 PLAYWRIGHT_SLOWMO=1000 yarn test:e2e --headed",
+    "test:e2e:full": "ALL_BROWSERS=1 yarn test:e2e",
+    "lint": "eslint src --ext .js,.ts,.jsx,.tsx --cache",
     "preship": "yarn lint",
-    "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn publish && git push ${GHOST_UPSTREAM:-upstream} main --follow-tags; fi",
-    "posttest": "yarn lint",
-    "analyze": "source-map-explorer 'umd/*.js'",
-    "prepublishOnly": "yarn build",
-    "tailwind": "npx tailwindcss -i ./src/index.css -o ./public/main.css --watch --minify",
-    "cypress:open": "cypress open",
-    "cypress": "cypress run"
+    "ship": "STATUS=$(git status --porcelain); echo $STATUS; if [ -z \"$STATUS\" ]; then yarn version; fi",
+    "postship": "git push ${GHOST_UPSTREAM:-origin} --follow-tags && npm publish",
+    "prepublishOnly": "yarn build"
   },
   "browserslist": {
     "production": [
@@ -64,31 +42,43 @@
       "last 1 safari version"
     ]
   },
-  "devDependencies": {
-    "@testing-library/jest-dom": "5.16.2",
-    "@testing-library/react": "12.1.2",
-    "@testing-library/user-event": "^14.4.3",
-    "autoprefixer": "^10.4.7",
-    "bson-objectid": "^2.0.3",
-    "chalk": "4.1.2",
-    "chokidar": "3.5.2",
-    "copy-webpack-plugin": "6.4.1",
-    "cypress": "^10.7.0",
-    "eslint-config-react-app": "^7.0.1",
-    "eslint-plugin-cypress": "^2.12.1",
-    "eslint-plugin-ghost": "2.12.0",
-    "eslint-plugin-tailwindcss": "^3.6.0",
-    "minimist": "1.2.5",
-    "ora": "5.4.1",
-    "postcss": "^8.4.14",
-    "rewire": "6.0.0",
-    "serve-handler": "6.1.3",
-    "source-map-explorer": "2.5.2",
-    "tailwindcss": "^3.1.4",
-    "webpack-cli": "3.3.12"
+  "dependencies": {
+    "@headlessui/react": "1.7.15",
+    "@tiptap/core": "2.0.4",
+    "@tiptap/extension-blockquote": "2.0.4",
+    "@tiptap/extension-document": "2.0.4",
+    "@tiptap/extension-hard-break": "2.0.4",
+    "@tiptap/extension-link": "2.0.4",
+    "@tiptap/extension-paragraph": "2.0.4",
+    "@tiptap/extension-placeholder": "2.0.4",
+    "@tiptap/extension-text": "2.0.4",
+    "@tiptap/pm": "2.0.4",
+    "@tiptap/react": "2.0.4",
+    "react": "17.0.2",
+    "react-dom": "17.0.2",
+    "react-string-replace": "1.1.1"
   },
-  "resolutions": {
-    "//": "See https://github.com/facebook/create-react-app/issues/11773",
-    "react-error-overlay": "6.0.9"
+  "devDependencies": {
+    "@playwright/test": "1.37.0",
+    "@testing-library/jest-dom": "5.16.5",
+    "@testing-library/react": "12.1.5",
+    "@testing-library/user-event": "14.4.3",
+    "@tryghost/i18n": "0.0.0",
+    "@vitejs/plugin-react": "4.0.4",
+    "@vitest/coverage-v8": "0.33.0",
+    "autoprefixer": "10.4.15",
+    "bson-objectid": "2.0.4",
+    "concurrently": "8.2.1",
+    "eslint-plugin-i18next": "6.0.3",
+    "eslint-plugin-react-hooks": "4.6.0",
+    "eslint-plugin-react-refresh": "0.4.3",
+    "eslint-plugin-tailwindcss": "3.13.0",
+    "jsdom": "22.1.0",
+    "postcss": "8.4.28",
+    "tailwindcss": "3.3.3",
+    "vite": "4.4.9",
+    "vite-plugin-css-injected-by-js": "3.3.0",
+    "vite-plugin-svgr": "3.2.0",
+    "vitest": "0.34.2"
   }
 }