Add initial package structure

.editorconfig

@@ -0,0 +1,36 @@
+# EditorConfig Configurtaion file, for more details see:
+# http://EditorConfig.org
+# EditorConfig is a convention description, that could be interpreted
+# by multiple editors to enforce common coding conventions for specific
+# file types
+
+# top-most EditorConfig file:
+# Will ignore other EditorConfig files in Home directory or upper tree level.
+root = true
+
+
+[*]  # For All Files
+# Unix-style newlines with a newline ending every file
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+# Set default charset
+charset = utf-8
+# Indent style default
+indent_style = space
+# Max Line Length - a hard line wrap, should be disabled
+max_line_length = off
+
+[*.{py,cfg,ini}]
+# 4 space indentation
+indent_size = 4
+
+[*.{html,dtml,pt,zpt,xml,zcml,js,jsx,json,less,css,yaml,yml}]
+# 2 space indentation
+indent_size = 2
+
+[{Makefile,.gitmodules}]
+# Tab indentation (no size specified, but view as 4 spaces)
+indent_style = tab
+indent_size = unset
+tab_width = unset

.gitignore

@@ -0,0 +1 @@
+node_modules

.prettierignore

@@ -0,0 +1,2 @@
+CHANGELOG.md
+README.md

.project.eslintrc.js

@@ -0,0 +1,50 @@
+const fs = require('fs');
+const path = require('path');
+
+const projectRootPath = fs.realpathSync('./project'); // __dirname
+const packageJson = require(path.join(projectRootPath, 'package.json'));
+
+let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
+
+let configFile;
+if (fs.existsSync(`${this.projectRootPath}/tsconfig.json`))
+  configFile = `${this.projectRootPath}/tsconfig.json`;
+else if (fs.existsSync(`${this.projectRootPath}/jsconfig.json`))
+  configFile = `${this.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,
+]);
+
+module.exports = {
+  extends: `${voltoPath}/.eslintrc`,
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@plone/volto', '@plone/volto/src'],
+          ...addonAliases,
+          ['@package', `${__dirname}/src`],
+          ['@root', `${__dirname}/src`],
+          ['~', `${__dirname}/src`],
+        ],
+        extensions: ['.js', '.jsx', '.json'],
+      },
+      'babel-plugin-root-import': {
+        rootPathSuffix: 'src',
+      },
+    },
+  },
+};

Makefile

@@ -0,0 +1,58 @@
+# Yeoman Volto App development
+
+### Defensive settings for make:
+#     https://tech.davis-hansson.com/p/make/
+SHELL:=bash
+.ONESHELL:
+.SHELLFLAGS:=-xeu -o pipefail -O inherit_errexit -c
+.SILENT:
+.DELETE_ON_ERROR:
+MAKEFLAGS+=--warn-undefined-variables
+MAKEFLAGS+=--no-builtin-rules
+
+# Project settings
+
+DIR=$(shell basename $$(pwd))
+ADDON ?= "@plone-collective/volto-sentry"
+
+# Recipe snippets for reuse
+
+# We like colors
+# From: https://coderwall.com/p/izxssa/colored-makefile-for-golang-projects
+RED=`tput setaf 1`
+GREEN=`tput setaf 2`
+RESET=`tput sgr0`
+YELLOW=`tput setaf 3`
+
+
+# Top-level targets
+
+.PHONY: project
+project:
+	npm install -g yo
+	npm install -g @plone/generator-volto
+	npm install -g mrs-developer
+	yo @plone/volto project --addon ${ADDON} --workspace "src/addons/${DIR}" --no-interactive
+	ln -sf $$(pwd) project/src/addons/
+	cp .project.eslintrc.js .eslintrc.js
+	cd project && yarn
+	@echo "-------------------"
+	@echo "$(GREEN)Volto project is ready!$(RESET)"
+	@echo "$(RED)Now run: cd project && yarn start$(RESET)"
+
+.PHONY: all
+all: project
+
+.PHONY: start-test-backend
+start-test-backend: ## Start Test Plone Backend
+	@echo "$(GREEN)==> Start Test Plone Backend$(RESET)"
+	docker run -i --rm -e ZSERVER_HOST=0.0.0.0 -e ZSERVER_PORT=55001 -p 55001:55001 -e SITE=plone -e APPLY_PROFILES=plone.app.contenttypes:plone-content,plone.restapi:default,plone.volto:default-homepage -e CONFIGURE_PACKAGES=plone.app.contenttypes,plone.restapi,plone.volto,plone.volto.cors -e ADDONS='plone.app.robotframework plone.app.contenttypes plone.restapi plone.volto' plone ./bin/robot-server plone.app.robotframework.testing.PLONE_ROBOT_TESTING
+
+.PHONY: start-backend-docker
+start-backend-docker:		## Starts a Docker-based backend
+	@echo "$(GREEN)==> Start Docker-based Plone Backend$(RESET)"
+	docker run -it --rm --name=plone -p 8080:8080 -e SITE=Plone -e ADDONS="plone.volto" -e ZCML="plone.volto.cors" plone
+
+.PHONY: help
+help:		## Show this help.
+	@echo -e "$$(grep -hE '^\S+:.*##' $(MAKEFILE_LIST) | sed -e 's/:.*##\s*/:/' -e 's/^\(.\+\):\(.*\)/\\x1b[36m\1\\x1b[m:\2/' | column -c2 -t -s :)"

babel.config.js

@@ -0,0 +1,17 @@
+module.exports = function (api) {
+  api.cache(true);
+  const presets = ['razzle/babel'];
+  const plugins = [
+    [
+      'react-intl', // React Intl extractor, required for the whole i18n infrastructure to work
+      {
+        messagesDir: './build/messages/',
+      },
+    ],
+  ];
+
+  return {
+    plugins,
+    presets,
+  };
+};

cypress/fixtures/example.json

@@ -0,0 +1,5 @@
+{
+  "name": "Using fixtures to represent data",
+  "email": "hello@cypress.io",
+  "body": "Fixtures are a great way to mock data for responses to routes"
+}

cypress/plugins/index.js

@@ -0,0 +1,17 @@
+// ***********************************************************
+// This example plugins/index.js can be used to load plugins
+//
+// You can change the location of this file or turn off loading
+// the plugins file with the 'pluginsFile' configuration option.
+//
+// You can read more here:
+// https://on.cypress.io/plugins-guide
+// ***********************************************************
+
+// This function is called when a project is opened or re-opened (e.g. due to
+// the project's config changing)
+
+module.exports = (on, config) => {
+  // `on` is used to hook into various events Cypress emits
+  // `config` is the resolved Cypress config
+};

cypress/support/commands.js

@@ -0,0 +1,9 @@
+import '@plone/volto/cypress/add-commands';
+
+// Set PLONE_SITE_ID and PLONE_API_URL as cypress environment variables
+//   if testing without using localhost or a site id of `plone`.
+
+// --- CUSTOM COMMANDS -------------------------------------------------------------
+Cypress.Commands.add('custom_command', () => {
+  // Custom code here...
+});

cypress/support/index.js

@@ -0,0 +1,13 @@
+import 'cypress-file-upload';
+import './commands';
+import 'cypress-axe';
+
+beforeEach(function () {
+  cy.log('Setting up API fixture');
+  cy.exec('yarn cy:test:fixture:setup');
+});
+
+afterEach(function () {
+  cy.log('Tearing down API fixture');
+  cy.exec('yarn cy:test:fixture:teardown');
+});

cypress/support/reset-fixture.js

@@ -0,0 +1,44 @@
+const xmlrpc = require('xmlrpc');
+const command = process.argv[2];
+
+// create a client
+const client = xmlrpc.createClient({
+  host: process.env.CYPRESS_BACKEND_HOST || 'localhost',
+  port: 55001,
+  path: '/plone/RobotRemote',
+});
+
+function setup() {
+  // Setup site
+  client.methodCall(
+    'run_keyword',
+    [
+      'remote_zodb_setup',
+      ['plone.app.robotframework.testing.PLONE_ROBOT_TESTING'],
+    ],
+    () => {},
+  );
+}
+
+function teardown() {
+  // Tearing down
+  client.methodCall(
+    'run_keyword',
+    [
+      'remote_zodb_teardown',
+      ['plone.app.robotframework.testing.PLONE_ROBOT_TESTING'],
+    ],
+    () => {},
+  );
+}
+
+switch (command) {
+  case 'setup':
+    setup();
+    break;
+  case 'teardown':
+    teardown();
+    break;
+  default:
+    setup();
+}

jest-addon.config.js

@@ -0,0 +1,33 @@
+module.exports = {
+  testMatch: ['**/src/addons/**/?(*.)+(spec|test).[jt]s?(x)'],
+  collectCoverageFrom: [
+    'src/addons/**/src/**/*.{js,jsx,ts,tsx}',
+    '!src/**/*.d.ts',
+  ],
+  transformIgnorePatterns: ['node_modules/(?!(volto-slate|@plone/volto)/)'],
+  moduleNameMapper: {
+    '@plone/volto/cypress': '<rootDir>/node_modules/@plone/volto/cypress',
+    '@plone/volto/babel': '<rootDir>/node_modules/@plone/volto/babel',
+    '@plone/volto/(.*)$': '<rootDir>/node_modules/@plone/volto/src/$1',
+    '@package/(.*)$': '<rootDir>/src/$1',
+    '@root/(.*)$': '<rootDir>/src/$1',
+    '~/(.*)$': '<rootDir>/src/$1',
+    'load-volto-addons':
+      '<rootDir>/node_modules/@plone/volto/jest-addons-loader.js',
+    '\\.(css|less|scss|sass)$': 'identity-obj-proxy',
+  },
+  transform: {
+    '^.+\\.js(x)?$': 'babel-jest',
+    '^.+\\.(png)$': 'jest-file',
+    '^.+\\.(jpg)$': 'jest-file',
+    '^.+\\.(svg)$': './node_modules/@plone/volto/jest-svgsystem-transform.js',
+  },
+  coverageThreshold: {
+    global: {
+      branches: 5,
+      functions: 5,
+      lines: 5,
+      statements: 5,
+    },
+  },
+};

locales/volto.pot

@@ -0,0 +1,14 @@
+msgid ""
+msgstr ""
+"Project-Id-Version: Plone\n"
+"POT-Creation-Date: 2021-01-29T12:34:47.097Z\n"
+"Last-Translator: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"Language-Team: Plone i18n <plone-i18n@lists.sourceforge.net>\n"
+"MIME-Version: 1.0\n"
+"Content-Type: text/plain; charset=utf-8\n"
+"Content-Transfer-Encoding: 8bit\n"
+"Plural-Forms: nplurals=1; plural=0;\n"
+"Language-Code: en\n"
+"Language-Name: English\n"
+"Preferred-Encodings: utf-8\n"
+"Domain: volto\n"

package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@plone-collective/volto-sentry",
+  "version": "0.1.0",
+  "description": "volto-sentry: Volto add-on",
+  "main": "src/index.js",
+  "license": "MIT",
+  "keywords": [
+    "volto-addon",
+    "volto",
+    "plone",
+    "react"
+  ],
+  "scripts": {
+    "i18n": "rm -rf build/messages && NODE_ENV=production i18n --addon"
+  },
+  "devDependencies": {
+    "@plone/scripts": "*"
+  },
+  "dependencies": {
+    "@sentry/browser": "7.15.0",
+    "@sentry/integrations": "7.15.0",
+    "@sentry/node": "7.15.0",
+    "@sentry/webpack-plugin": "1.19.1"
+  }
+}

scripts/create-sentry-release.sh

@@ -0,0 +1,24 @@
+#!/usr/bin/env bash
+PARAM=$1
+if [ -z $PARAM ]; then
+  PARAM='not forced'
+fi
+if [ ! -z "$SENTRY_AUTH_TOKEN" ] && [ ! -z "$SENTRY_URL" ] && [ ! -z "$SENTRY_ORG" ] && [ ! -z "$SENTRY_PROJECT" ] && [ ! -z "$SENTRY_RELEASE" ]; then
+  CREATE=1
+  if [[ ! $PARAM = '--force' ]]; then
+    if ./node_modules/@sentry/cli/sentry-cli releases info $SENTRY_RELEASE | grep -q $SENTRY_RELEASE; then
+      CREATE=0
+    fi
+  fi
+  if [ $CREATE = 1 ]; then
+    ./node_modules/@sentry/cli/sentry-cli releases new $SENTRY_RELEASE
+    ./node_modules/@sentry/cli/sentry-cli releases files $SENTRY_RELEASE upload ./build/public/static/ --url-prefix "~/static"
+    ./node_modules/@sentry/cli/sentry-cli releases finalize $SENTRY_RELEASE
+  fi
+  if [ $CREATE = 0 ]; then
+    echo "Release $SENTRY_RELEASE already exists"
+    echo "Use --force if you still want to upload the source maps"
+  fi
+else
+  echo "SENTRY is not configured"
+fi

src/index.js

@@ -0,0 +1,5 @@
+const applyConfig = (config) => {
+  return config;
+};
+
+export default applyConfig;