Merge pull request #160 from collective/refactor-development

Update development files

.github/workflows/main.yml

@@ -12,12 +12,21 @@ jobs:
       matrix:
         python:
           - "3.8"
-          - "3.9"
           - "3.10"
           - "3.11"
           - "3.12"
         plone:
           - "6.0-latest"
+          - "6.1-latest"
+        exclude:
+          - python: "3.10"
+            plone: "6.0-latest"
+          - python: "3.12"
+            plone: "6.0-latest"
+          - python: "3.8"
+            plone: "6.1-latest"
+          - python: "3.11"
+            plone: "6.1-latest"
 
     steps:
       - uses: actions/checkout@v4
@@ -28,8 +37,6 @@ jobs:
         with:
           python-version: ${{ matrix.python }}
           plone-version: ${{ matrix.plone }}
-          setuptools-version: 69.5.1
-          additional-eggs: 'setuptools'
       - name: Install package
         run: |
           make install
@@ -41,3 +48,7 @@ jobs:
       - name: Run tests
         run: |
           make test-ignore-warnings
+
+      - name: Run Javascript Tests
+        run: |
+          cd resources; make test

.gitignore

@@ -20,6 +20,8 @@ __pycache__/
 .tox
 .vscode/
 node_modules/
+forest.dot
+forest.json
 
 # venv / buildout related
 bin/
@@ -46,7 +48,8 @@ local.cfg
 /venv/
 .installed.txt
 
-forest.*
+robot_*
+test_*
 
 ##
 # Add extra configuration options in .meta.toml:

.meta.toml

@@ -3,7 +3,7 @@
 # See the inline comments on how to expand/tweak this configuration file
 [meta]
 template = "default"
-commit-id = "5d22fbf8"
+commit-id = "4cf2df11"
 
 [pyproject]
 codespell_skip = "*.js,*.min.js,*.min.js.map,*.min.css.map,*.svg,*.lock,*.json"
@@ -17,5 +17,6 @@ jobs = [
 
 [gitignore]
 extra_lines = """
-forest.*
+robot_*
+test_*
 """

MANIFEST.in

@@ -1,23 +1,20 @@
-exclude Makefile *.cfg *.in *.nix *.sh *.conf *.js *.json Procfile .jshintrc *-mxdev.txt .installed.txt
+exclude Makefile *.cfg *.in *.nix *.sh *.conf *.js *.json Procfile .jshintrc *-mxdev.txt .installed.txt *.yaml *.ini
+global-exclude *.pyc
+global-exclude *.yarn-integrity
+global-exclude cypress.json
+global-exclude cypress/**/*
+global-exclude node_modules/**
+global-exclude resources/**
 include *.py
 include *.rst
 include *.txt
 include .coveragerc
 include buildout.cfg
-include *.yaml
-include mx.ini
 recursive-include images *.gif
 recursive-include docs *.GPL
 recursive-include docs *.bugfix
 recursive-include docs *.gif
 recursive-include docs *.md
 recursive-include docs *.png
 recursive-include docs *.rst
-prune src/collective/taxonomy/javascripts/node_modules/**/*
 graft src
-exclude src/collective/taxonomy/javascripts/build/messages/src/js/components/*.json
-global-exclude *.pyc
-global-exclude *.yarn-integrity
-global-exclude cypress.json
-global-exclude cypress/**/*
-global-exclude node_modules/**

README.rst

@@ -160,14 +160,34 @@ The languages allowed for the taxonomies are the languages defined in ``portal_l
 Development
 ===========
 
-Run the app, run ``npm start`` in the ``javascripts`` directory.
-To make Plone use the development code, you need the ``NODE_ENV`` environment
-variable to be set to ``development``:
+All JS development resources are in the directory ``resources/js``.
+
+While making changes to these files you can:
+
+  1. change to directory ``resources/``
+  2. run ``make serve``
+
+This starts a webpack development server at ``localhost:3000`` and
+serves the JS files.
+
+Now start your Plone instance with
 
 ::
 
     NODE_ENV=development bin/instance fg
 
+and the taxonomy controlpanel will use the files served from the webpack server.
+
+When you have finished your changes run:
+
+::
+
+    make test
+    make build
+
+this will build the resources and save it in ``src/collective/taxonomy/static/js``.
+
+
 
 i18n
 ----

src/collective/taxonomy/javascripts/.eslintrc → resources/.eslintrc

@@ -1,16 +1,12 @@
 {
-  "extends": "airbnb",
+  "extends": ["eslint:recommended"],
   "parser": "babel-eslint",
   "env": {
     "browser": true,
     "es6": true,
     "jquery": true,
     "mocha": true
   },
-  "ecmaFeatures": {
-    "jsx": true,
-    "modules": true,
-  },
   "rules": {
     "array-bracket-spacing": [2, "never"],
     "no-redeclare": 0,
@@ -34,6 +30,6 @@
   ],
   "globals": {
     "__DEV__" : true,
-    "expect": true,
+    "expect": true
   }
 }

src/collective/taxonomy/javascripts/.gitignore → resources/.gitignore

@@ -1,2 +1,3 @@
 yarn-error.log
 cypress/screenshots/
+stamp-yarn

resources/Makefile

@@ -0,0 +1,29 @@
+# Taxonomy JS Development
+
+YARN   ?= npx yarn
+
+
+.PHONY: install
+stamp-yarn install:
+	$(YARN) install
+	touch stamp-yarn
+
+
+.PHONY:
+build: stamp-yarn
+	$(YARN) run build
+
+
+.PHONY:
+serve: stamp-yarn
+	$(YARN) run start
+
+
+.PHONY:
+test: stamp-yarn
+	$(YARN) run test
+
+
+.PHONY:
+lint: stamp-yarn
+	$(YARN) run lint

src/collective/taxonomy/javascripts/package.json → resources/package.json

@@ -35,7 +35,7 @@
     "chai-spies": "*",
     "cypress": "^4.3.0",
     "eslint": "^6.6.0",
-    "eslint-config-airbnb": "^9.0.1",
+    "eslint-config-prettier": "^9.0.0",
     "eslint-plugin-import": "^1.7.0",
     "eslint-plugin-jsx-a11y": "^1.2.0",
     "eslint-plugin-react": "^5.1.1",
@@ -49,7 +49,7 @@
     "redux-devtools-log-monitor": "^1.0.11",
     "webpack": "^3.12.0",
     "webpack-dev-middleware": "^1.2.0",
-    "webpack-hot-middleware": "^2.25.4"
+    "webpack-hot-middleware": "^2.26.1"
   },
   "dependencies": {
     "har-validator": "5.1.5",
@@ -66,5 +66,9 @@
     "redux-thunk": "^2.1.0",
     "uid": "0.0.2",
     "whatwg-fetch": "^1.0.0"
+  },
+  "volta": {
+    "node": "18.20.3",
+    "yarn": "1.22.22"
   }
 }

resources/webpack.config.prod.js

@@ -0,0 +1,44 @@
+var path = require('path')
+var webpack = require('webpack')
+
+module.exports = () => {
+  const config = {
+    devtool: 'cheap-module-source-map', // https://webpack.js.org/configuration/devtool
+    entry: {
+      edittaxonomydata: ['./src/js/index'],
+    },
+    output: {
+      path: path.join(__dirname, '../src/collective/taxonomy/static/js'),
+      filename: '[name].js',
+    },
+    plugins: [
+      new webpack.IgnorePlugin(/^(buffertools)$/),
+      new webpack.optimize.OccurrenceOrderPlugin(),
+      new webpack.DefinePlugin({
+        'process.env.NODE_ENV': JSON.stringify('production')
+      }),
+      new webpack.optimize.UglifyJsPlugin({
+        compressor: {
+          pure_getters: true,
+          unsafe: true,
+          unsafe_comps: true,
+          screw_ie8: true,
+          warnings: false
+        }
+      })
+    ],
+    module: {
+      loaders: [{
+        test: /\.js$/,
+        loaders: ['babel-loader'],
+        exclude: /node_modules/,
+        include: path.join(__dirname, 'src'),
+      }]
+    }
+  };
+
+  console.log(JSON.stringify(config, null, 4));
+
+  return config;
+
+}