@eeacms/volto-eea-design-system 0.2.1

package/.coverage.babel.config.js

@@ -0,0 +1,13 @@
+const defaultBabel = require('@plone/volto/babel');
+
+function applyDefault(api) {
+  const voltoBabel = defaultBabel(api);
+  voltoBabel.plugins.push(
+    '@babel/plugin-transform-modules-commonjs',
+    'transform-class-properties',
+    'istanbul',
+  );
+  return voltoBabel;
+}
+
+module.exports = applyDefault;

package/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,50 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+---
+
+## React guidelines
+
+### Basic guidelines
+
+- [ ] One React component per file
+- [ ] Use best practice naming conventions, follow the library styles (semantic-ui-less, semantic-ui-react).
+- [ ] Ensure every file uses Unix line endings
+
+### Naming guidelines
+
+- [ ] Filename: Use PascalCase for filenames. E.g., ItemCard.jsx
+- [ ] Variable naming: Use PascalCase for React components and camelCase for their instances
+- [ ] Use the filename as the component name, ReservationCard.jsx should have a reference name of ReservationCard
+- [ ] Use camelCase for prop names, or PascalCase if the prop value is a React component
+
+### Component best practice guidelines
+
+- [ ] Don't hard-code values, make them props
+- [ ] Avoid using inline styles except for setting background images or visibility of elements
+- [ ] Use imports relative to the package name
+- [ ] Use whitespace to separate and group imports from other code
+- [ ] Large composite components (for example the Footer) should be abstracted and split into multiple subcomponents
+
+### Storybook best practice guidelines
+
+- [ ] Aim for realistic demo aspects, For example, a mix of short and long text.
+- [ ] Variations should be provided as separate stories
+- [ ] Aim for a comprehensive but realistic set of control options
+- [ ] Provide guidelines as to what combinations of props and variations are allowed
+
+## Theming guidelines
+
+- [ ] Style directly the SUI components without introducing new markup or classes
+- [ ] Use variables everywhere it is possible
+- [ ] Remove or modify overrides to use variables instead of hard-coded values
+- [ ] Don't add HTML tags to the css specificity selector
+- [ ] Add custom classes after the semantic ui classes
+- [ ] Use Semantic UI naming style
+- [ ] Keep important rules to a minimum and make sure they are well documented
+- [ ] Use relative units in general
+- [ ] Check components design when having odd numbers or images
+- [ ] Check components with every responsive design preview sizes both in landscape and portrait

package/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,50 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+---
+
+## React guidelines
+
+### Basic guidelines
+
+- [ ] One React component per file
+- [ ] Use best practice naming conventions, follow the library styles (semantic-ui-less, semantic-ui-react).
+- [ ] Ensure every file uses Unix line endings
+
+### Naming guidelines
+
+- [ ] Filename: Use PascalCase for filenames. E.g., ItemCard.jsx
+- [ ] Variable naming: Use PascalCase for React components and camelCase for their instances
+- [ ] Use the filename as the component name, ReservationCard.jsx should have a reference name of ReservationCard
+- [ ] Use camelCase for prop names, or PascalCase if the prop value is a React component
+
+### Component best practice guidelines
+
+- [ ] Don't hard-code values, make them props
+- [ ] Avoid using inline styles except for setting background images or visibility of elements
+- [ ] Use imports relative to the package name
+- [ ] Use whitespace to separate and group imports from other code
+- [ ] Large composite components (for example the Footer) should be abstracted and split into multiple subcomponents
+
+### Storybook best practice guidelines
+
+- [ ] Aim for realistic demo aspects, For example, a mix of short and long text.
+- [ ] Variations should be provided as separate stories
+- [ ] Aim for a comprehensive but realistic set of control options
+- [ ] Provide guidelines as to what combinations of props and variations are allowed
+
+## Theming guidelines
+
+- [ ] Style directly the SUI components without introducing new markup or classes
+- [ ] Use variables everywhere it is possible
+- [ ] Remove or modify overrides to use variables instead of hard-coded values
+- [ ] Don't add HTML tags to the css specificity selector
+- [ ] Add custom classes after the semantic ui classes
+- [ ] Use Semantic UI naming style
+- [ ] Keep important rules to a minimum and make sure they are well documented
+- [ ] Use relative units in general
+- [ ] Check components design when having odd numbers or images
+- [ ] Check components with every responsive design preview sizes both in landscape and portrait

package/.github/workflows/node.js.yml

@@ -0,0 +1,59 @@
+# This workflow will do a clean install of node dependencies, cache/restore them, build the source code and run tests across different versions of node
+# For more information see: https://help.github.com/actions/language-and-framework-guides/using-nodejs-with-github-actions
+
+name: Storybook & Docusaurus CI deployment
+
+on:
+  push:
+    branches: [ develop ]
+    paths:
+      - src/**
+      - theme/**
+      - website/**
+      - templates/**
+
+jobs:
+  build:
+
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version: [16.x]
+        # See supported Node.js release schedule at https://nodejs.org/en/about/releases/
+
+    steps:
+    - uses: actions/checkout@v2
+      with:
+        ref: ${{ github.head_ref }}
+        fetch-depth: 0
+    - name: Use Node.js ${{ matrix.node-version }} to build docusaurus website
+      uses: actions/setup-node@v2
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Push Docusaurus build changes
+      run: |
+          git config user.name github-actions
+          git config user.email github-actions@github.com
+          git pull
+          git fetch
+          npx auto-changelog --commit-limit false  --unreleased --stdout  --template templates/eea.hbs > website/docs/2-whatsnew.md
+          cd website
+          yarn
+          yarn build
+          cd ..
+          git add website docs 
+          git commit -m "Autobuild of docusaurus docs"
+          git push
+
+    - uses: convictional/trigger-workflow-and-wait@v1.3.0
+      with:
+        github_token: ${{ secrets.PAT_TOKEN }}
+        owner: 'eea'
+        repo: 'volto-kitkat-frontend'
+        ref: 'develop'
+        workflow_file_name: node.js.yml
+    - name: Deploy Storybook changes
+      run: |
+          echo "Deploy Storybook changes"
+          sleep 1s

package/.prettierignore

@@ -0,0 +1,4 @@
+docs/
+.github/workflows/node.js.yml
+CHANGELOG.md
+README.md

package/.project.eslintrc.js

@@ -0,0 +1,45 @@
+const fs = require('fs');
+const path = require('path');
+
+const projectRootPath = fs.realpathSync('./project'); // __dirname
+const packageJson = require(path.join(projectRootPath, 'package.json'));
+const jsConfig = require(path.join(projectRootPath, 'jsconfig.json'))
+  .compilerOptions;
+
+const pathsConfig = jsConfig.paths;
+
+let voltoPath = path.join(projectRootPath, 'node_modules/@plone/volto');
+
+Object.keys(pathsConfig).forEach((pkg) => {
+  if (pkg === '@plone/volto') {
+    voltoPath = `./${jsConfig.baseUrl}/${pathsConfig[pkg][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: `${projectRootPath}/node_modules/@plone/volto/.eslintrc`,
+  settings: {
+    'import/resolver': {
+      alias: {
+        map: [
+          ['@plone/volto', '@plone/volto/src'],
+          ...addonAliases,
+          ['@package', `${__dirname}/src`],
+          ['~', `${__dirname}/src`],
+        ],
+        extensions: ['.js', '.jsx', '.json'],
+      },
+      'babel-plugin-root-import': {
+        rootPathSuffix: 'src',
+      },
+    },
+  },
+};

package/.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"
+  }
+}

package/.storybook/manager.js

@@ -0,0 +1,15 @@
+import { addons } from '@storybook/addons';
+
+addons.setConfig({
+  isFullscreen: false,
+  showNav: true,
+  showPanel: true,
+  panelPosition: 'bottom',
+  sidebarAnimations: true,
+  enableShortcuts: true,
+  isToolshown: true,
+  theme: undefined,
+  selectedPanel: undefined,
+  initialActive: 'sidebar',
+  showRoots: true,
+});