Initialize develop

.coverage.babel.config.js

@@ -0,0 +1,9 @@
+const defaultBabel = require('@plone/volto/babel');
+
+function applyDefault(api) {
+  const voltoBabel = defaultBabel(api);
+  voltoBabel.plugins.push('istanbul');
+  return voltoBabel;
+}
+
+module.exports = applyDefault;

.env

@@ -0,0 +1,5 @@
+# Jest configuration variables
+# - possible values: ON, OFF
+
+# Allow usage of jest.setup.js file, useful for when you want to use common configuration
+JEST_USE_SETUP=OFF

.eslintrc.js

@@ -0,0 +1,65 @@
+const fs = require('fs');
+const path = require('path');
+const projectRootPath = fs.realpathSync(__dirname + '/../../../');
+
+let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
+let configFile;
+if (fs.existsSync(`${projectRootPath}/tsconfig.json`))
+  configFile = `${projectRootPath}/tsconfig.json`;
+else if (fs.existsSync(`${projectRootPath}/jsconfig.json`))
+  configFile = `${projectRootPath}/jsconfig.json`;
+
+if (configFile) {
+  const jsConfig = require(configFile).compilerOptions;
+  const pathsConfig = jsConfig.paths;
+  if (pathsConfig['@plone/volto'])
+    voltoPath = `./${jsConfig.baseUrl}/${pathsConfig['@plone/volto'][0]}`;
+}
+
+const AddonConfigurationRegistry = require(`${voltoPath}/addon-registry.js`);
+const reg = new AddonConfigurationRegistry(projectRootPath);
+
+// Extends ESlint configuration for adding the aliases to `src` directories in Volto addons
+const addonAliases = Object.keys(reg.packages).map((o) => [
+  o,
+  reg.packages[o].modulePath,
+]);
+
+const addonExtenders = reg.getEslintExtenders().map((m) => require(m));
+
+const defaultConfig = {
+  extends: `${voltoPath}/.eslintrc`,
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@plone/volto', '@plone/volto/src'],
+          ['@plone/volto-slate', '@plone/volto/packages/volto-slate/src'],
+          ...addonAliases,
+          ['@package', `${__dirname}/src`],
+          ['@root', `${__dirname}/src`],
+          ['~', `${__dirname}/src`],
+        ],
+        extensions: ['.js', '.jsx', '.json'],
+      },
+      'babel-plugin-root-import': {
+        rootPathSuffix: 'src',
+      },
+    },
+  },
+  rules: {
+    'react/jsx-no-target-blank': [
+      'error',
+      {
+        allowReferrer: true,
+      },
+    ],
+  }
+};
+
+const config = addonExtenders.reduce(
+  (acc, extender) => extender.modify(acc),
+  defaultConfig,
+);
+
+module.exports = config;

.gitignore

@@ -0,0 +1,26 @@
+.vscode/
+.history
+.nyc_output
+project
+coverage
+logs
+*.log
+npm-debug.log*
+.DS_Store
+*.swp
+yarn-error.log
+yarn.lock
+package-lock.json
+
+node_modules
+build
+dist
+cypress/videos
+cypress/reports
+screenshots
+videos
+.env.local
+.env.development.local
+.env.test.local
+.env.production.local
+*~

.husky/pre-commit

@@ -0,0 +1,2 @@
+[ -n "$CI" ] && exit 0
+yarn lint-staged

.npmignore

@@ -0,0 +1,96 @@
+# https://docs.npmjs.com/using-npm/developers.html#keeping-files-out-of-your-package
+
+# Directories
+api/
+bin/
+build/
+lib/
+g-api/
+tests/
+
+# Docs
+docs/
+
+# Cypress
+cypress/
+
+# Tests
+__tests__/
+*.snap
+
+# Files
+.travis.yml
+requirements-docs.txt
+requirements-tests.txt
+yarn.lock
+.dockerignore
+.gitattributes
+.yarnrc
+.nvmrc
+changelogupdater.js
+pip-selfcheck.json
+Dockerfile
+CNAME
+entrypoint.sh
+Jenkinsfile
+Makefile
+
+# Logs
+logs
+*.log
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+
+# Runtime data
+pids
+*.pid
+*.seed
+*.pid.lock
+
+# Directory for instrumented libs generated by jscoverage/JSCover
+lib-cov
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# nyc test coverage
+.nyc_output
+
+# node-waf configuration
+.lock-wscript
+
+# Compiled binary addons (https://nodejs.org/api/addons.html)
+build/Release
+
+# Dependency directories
+node_modules/
+jspm_packages/
+
+# TypeScript v1 declaration files
+typings/
+
+# Optional npm cache directory
+.npm
+
+# Optional eslint cache
+.eslintcache
+
+# Optional REPL history
+.node_repl_history
+
+# Output of 'npm pack'
+*.tgz
+
+# Yarn Integrity file
+.yarn-integrity
+
+# dotenv environment variables file
+.env
+
+# next.js build output
+.next
+
+styleguide.config
+.vscode
+packages

.release-it.json

@@ -0,0 +1,17 @@
+{
+  "npm": {
+    "publish": false
+  },
+  "git": {
+    "changelog": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs",
+    "tagName": "${version}"
+  },
+  "github": {
+    "release": true,
+    "releaseName": "${version}",
+    "releaseNotes": "npx auto-changelog --stdout --commit-limit false -u --template https://raw.githubusercontent.com/release-it/release-it/master/templates/changelog-compact.hbs"
+  },
+  "hooks": {
+    "after:bump": "npx auto-changelog --commit-limit false -p"
+  }
+}

CHANGELOG.md

@@ -0,0 +1,5 @@
+# Changelog
+
+## 0.1.0
+
+- Initial release

DEVELOP.md

@@ -0,0 +1,106 @@
+# volto-addon-template
+
+## Develop
+
+1. Make sure you have `docker` and `docker compose` installed and running on your machine:
+
+    ```Bash
+    git clone https://github.com/eea/volto-addon-template.git
+    cd volto-addon-template
+    git checkout -b bugfix-123456 develop
+    make
+    make start
+    ```
+
+1. Wait for `Volto started at 0.0.0.0:3000` meesage
+
+1. Go to http://localhost:3000
+
+1. Initialize git hooks
+
+    ```Bash
+    yarn prepare
+    ```
+
+1. Happy hacking!
+
+### Or add @eeacms/volto-addon-template to your Volto project
+
+Before starting make sure your development environment is properly set. See [Volto Developer Documentation](https://docs.voltocms.com/getting-started/install/)
+
+1.  Make sure you have installed `yo`, `@plone/generator-volto` and `mrs-developer`
+
+        npm install -g yo @plone/generator-volto mrs-developer
+
+1.  Create new volto app
+
+        yo @plone/volto my-volto-project --addon @eeacms/volto-addon-template --skip-install
+        cd my-volto-project
+
+1.  Add the following to `mrs.developer.json`:
+
+        {
+            "volto-addon-template": {
+                "url": "https://github.com/eea/volto-addon-template.git",
+                "package": "@eeacms/volto-addon-template",
+                "branch": "develop",
+                "path": "src"
+            }
+        }
+
+1.  Install
+
+        make develop
+        yarn
+
+1.  Start backend
+
+        docker run --pull always -it --rm --name plone -p 8080:8080 -e SITE=Plone plone/plone-backend
+
+    ...wait for backend to setup and start - `Ready to handle requests`:
+
+    ...you can also check http://localhost:8080/Plone
+
+1.  Start frontend
+
+        yarn start
+
+1.  Go to http://localhost:3000
+
+1.  Happy hacking!
+
+        cd src/addons/volto-addon-template/
+
+## Cypress
+
+To run cypress locally, first make sure you don't have any Volto/Plone running on ports `8080` and `3000`.
+
+You don't have to be in a `clean-volto-project`, you can be in any Volto Frontend
+project where you added `volto-addon-template` to `mrs.developer.json`
+
+Go to:
+
+  ```BASH
+  cd src/addons/volto-addon-template/
+  ```
+
+Start:
+
+  ```Bash
+  make
+  make start
+  ```
+
+This will build and start with Docker a clean `Plone backend` and `Volto Frontend` with `volto-addon-template` block installed.
+
+Open Cypress Interface:
+
+  ```Bash
+  make cypress-open
+  ```
+
+Or run it:
+
+  ```Bash
+  make cypress-run
+  ```