@eeacms/volto-resize-helper
Advanced tools
Comparing version 0.2.10 to 1.0.0
@@ -5,3 +5,3 @@ const defaultBabel = require('@plone/volto/babel'); | ||
const voltoBabel = defaultBabel(api); | ||
voltoBabel.plugins.push('@babel/plugin-transform-modules-commonjs', 'transform-class-properties', 'istanbul'); | ||
voltoBabel.plugins.push('istanbul'); | ||
return voltoBabel; | ||
@@ -8,0 +8,0 @@ } |
@@ -7,83 +7,62 @@ ### Changelog | ||
#### [0.2.10](https://github.com/eea/volto-resize-helper/compare/0.2.9...0.2.10) | ||
### [1.0.0](https://github.com/eea/volto-resize-helper/compare/0.2.10...1.0.0) - 27 October 2022 | ||
#### :hammer_and_wrench: Others | ||
#### [0.2.9](https://github.com/eea/volto-resize-helper/compare/0.2.8...0.2.9) | ||
- Prepare 1.0.0 release [Miu Razvan - [`97965f1`](https://github.com/eea/volto-resize-helper/commit/97965f1deac22c291ea92569bb44d3bd0fcabd40)] | ||
- Bring this up to date [Miu Razvan - [`82b5968`](https://github.com/eea/volto-resize-helper/commit/82b59684b4d4ae20f18fee64770a733e73aef74d)] | ||
- update(jest): add @plone/volto-slate resolver refs- #153447 [nileshgulia1 - [`2bbd2cd`](https://github.com/eea/volto-resize-helper/commit/2bbd2cdf5db5cc8dfa0b96e27085ca738692e2f4)] | ||
### [0.2.10](https://github.com/eea/volto-resize-helper/compare/0.2.9...0.2.10) - 30 June 2022 | ||
> 6 April 2022 | ||
#### :hammer_and_wrench: Others | ||
- Release [`#11`](https://github.com/eea/volto-resize-helper/pull/11) | ||
- add usage docs [`90ab5d6`](https://github.com/eea/volto-resize-helper/commit/90ab5d686ba7511e3df5e509c8f2e5cb516a8cf8) | ||
### [0.2.9](https://github.com/eea/volto-resize-helper/compare/0.2.8...0.2.9) - 6 April 2022 | ||
#### [0.2.8](https://github.com/eea/volto-resize-helper/compare/0.2.7...0.2.8) | ||
#### :hammer_and_wrench: Others | ||
> 3 January 2022 | ||
- add usage docs [Nilesh - [`90ab5d6`](https://github.com/eea/volto-resize-helper/commit/90ab5d686ba7511e3df5e509c8f2e5cb516a8cf8)] | ||
### [0.2.8](https://github.com/eea/volto-resize-helper/compare/0.2.7...0.2.8) - 3 January 2022 | ||
### [0.2.7](https://github.com/eea/volto-resize-helper/compare/0.2.6...0.2.7) - 18 December 2021 | ||
#### [0.2.7](https://github.com/eea/volto-resize-helper/compare/0.2.6...0.2.7) | ||
#### :hammer_and_wrench: Others | ||
> 18 December 2021 | ||
### [0.2.6](https://github.com/eea/volto-resize-helper/compare/0.2.5...0.2.6) - 10 December 2021 | ||
- Add SonarQube badges [`#9`](https://github.com/eea/volto-resize-helper/pull/9) | ||
#### :hammer_and_wrench: Others | ||
#### [0.2.6](https://github.com/eea/volto-resize-helper/compare/0.2.5...0.2.6) | ||
- Refs #142010 - Optimize Volto-addons gitflow pipelines [valentinab25 - [`c19d7c2`](https://github.com/eea/volto-resize-helper/commit/c19d7c2e3ae1bf89b0e492906c60ca3b18118a1b)] | ||
### [0.2.5](https://github.com/eea/volto-resize-helper/compare/0.2.4...0.2.5) - 1 November 2021 | ||
> 10 December 2021 | ||
#### :hammer_and_wrench: Others | ||
- Develop [`#8`](https://github.com/eea/volto-resize-helper/pull/8) | ||
- Correct Cypress tests [`#7`](https://github.com/eea/volto-resize-helper/pull/7) | ||
- Refs #142010 - Optimize Volto-addons gitflow pipelines [`c19d7c2`](https://github.com/eea/volto-resize-helper/commit/c19d7c2e3ae1bf89b0e492906c60ca3b18118a1b) | ||
### [0.2.4](https://github.com/eea/volto-resize-helper/compare/0.2.3...0.2.4) - 24 June 2021 | ||
#### [0.2.5](https://github.com/eea/volto-resize-helper/compare/0.2.4...0.2.5) | ||
### [0.2.3](https://github.com/eea/volto-resize-helper/compare/0.2.2...0.2.3) - 24 June 2021 | ||
> 1 November 2021 | ||
### [0.2.2](https://github.com/eea/volto-resize-helper/compare/0.2.1...0.2.2) - 14 June 2021 | ||
- Added with-scrollbar class to <body> [`#6`](https://github.com/eea/volto-resize-helper/pull/6) | ||
### [0.2.1](https://github.com/eea/volto-resize-helper/compare/0.2.0...0.2.1) - 8 June 2021 | ||
#### [0.2.4](https://github.com/eea/volto-resize-helper/compare/0.2.3...0.2.4) | ||
#### :hammer_and_wrench: Others | ||
> 24 June 2021 | ||
- Prepare release 0.2.1 [Alin Voinea - [`0b3c91e`](https://github.com/eea/volto-resize-helper/commit/0b3c91e2e0b056b8d884f3027c9ba51028ebd7b7)] | ||
### [0.2.0](https://github.com/eea/volto-resize-helper/compare/0.1.1...0.2.0) - 8 June 2021 | ||
- Small fix [`#5`](https://github.com/eea/volto-resize-helper/pull/5) | ||
#### :hammer_and_wrench: Others | ||
#### [0.2.3](https://github.com/eea/volto-resize-helper/compare/0.2.2...0.2.3) | ||
- Release 0.2.0 [razvanMiu - [`66e2833`](https://github.com/eea/volto-resize-helper/commit/66e2833772b06950603f95ef8e537df91e02285a)] | ||
### [0.1.1](https://github.com/eea/volto-resize-helper/compare/0.1.0...0.1.1) - 31 May 2021 | ||
> 24 June 2021 | ||
#### :hammer_and_wrench: Others | ||
- Improvments [`#4`](https://github.com/eea/volto-resize-helper/pull/4) | ||
- Release 0.1.1 [razvanMiu - [`9e01658`](https://github.com/eea/volto-resize-helper/commit/9e01658d140cba59e478fd8bd55f07f48cdd3729)] | ||
- Delay on resize with 350ms to cover semantic ui container animation [razvanMiu - [`82f5c98`](https://github.com/eea/volto-resize-helper/commit/82f5c98ca8d8e3cc2d84d62786d78e3d5b5adb61)] | ||
- Update Readme [razvanMiu - [`b302ea3`](https://github.com/eea/volto-resize-helper/commit/b302ea334c06858cc8d83cdd638f37f1f53f9cb4)] | ||
### 0.1.0 - 31 May 2021 | ||
#### [0.2.2](https://github.com/eea/volto-resize-helper/compare/0.2.1...0.2.2) | ||
#### :hammer_and_wrench: Others | ||
> 14 June 2021 | ||
- fix when content is not present [`#3`](https://github.com/eea/volto-resize-helper/pull/3) | ||
#### [0.2.1](https://github.com/eea/volto-resize-helper/compare/0.2.0...0.2.1) | ||
> 8 June 2021 | ||
- Sync master/develop [`#2`](https://github.com/eea/volto-resize-helper/pull/2) | ||
- Prepare release 0.2.1 [`0b3c91e`](https://github.com/eea/volto-resize-helper/commit/0b3c91e2e0b056b8d884f3027c9ba51028ebd7b7) | ||
#### [0.2.0](https://github.com/eea/volto-resize-helper/compare/0.1.1...0.2.0) | ||
> 8 June 2021 | ||
- Better way to get screen & page sizes [`#1`](https://github.com/eea/volto-resize-helper/pull/1) | ||
- Release 0.2.0 [`66e2833`](https://github.com/eea/volto-resize-helper/commit/66e2833772b06950603f95ef8e537df91e02285a) | ||
#### [0.1.1](https://github.com/eea/volto-resize-helper/compare/0.1.0...0.1.1) | ||
> 31 May 2021 | ||
- Release 0.1.1 [`9e01658`](https://github.com/eea/volto-resize-helper/commit/9e01658d140cba59e478fd8bd55f07f48cdd3729) | ||
- Delay on resize with 350ms to cover semantic ui container animation [`82f5c98`](https://github.com/eea/volto-resize-helper/commit/82f5c98ca8d8e3cc2d84d62786d78e3d5b5adb61) | ||
- Update Readme [`b302ea3`](https://github.com/eea/volto-resize-helper/commit/b302ea334c06858cc8d83cdd638f37f1f53f9cb4) | ||
#### 0.1.0 | ||
> 31 May 2021 | ||
- Update imports [`7a30922`](https://github.com/eea/volto-resize-helper/commit/7a30922067f4e878d1ab47bb5bd26fded81b806f) | ||
- Added resize app extras [`52e7984`](https://github.com/eea/volto-resize-helper/commit/52e7984a488a67c70ed7a218afb0c22682a72976) | ||
- Initial commit [`4ad9c3e`](https://github.com/eea/volto-resize-helper/commit/4ad9c3e122176c535a777d7acd14b9ab565e964f) | ||
- Update imports [razvanMiu - [`7a30922`](https://github.com/eea/volto-resize-helper/commit/7a30922067f4e878d1ab47bb5bd26fded81b806f)] | ||
- Added resize app extras [razvanMiu - [`52e7984`](https://github.com/eea/volto-resize-helper/commit/52e7984a488a67c70ed7a218afb0c22682a72976)] | ||
- Initial commit [Miu Razvan - [`4ad9c3e`](https://github.com/eea/volto-resize-helper/commit/4ad9c3e122176c535a777d7acd14b9ab565e964f)] |
@@ -12,14 +12,14 @@ module.exports = { | ||
'@package/(.*)$': '<rootDir>/src/$1', | ||
'@root/(.*)$': '<rootDir>/src/$1', | ||
'@plone/volto-quanta/(.*)$': '<rootDir>/src/addons/volto-quanta/src/$1', | ||
'@eeacms/(.*?)/(.*)$': '<rootDir>/src/addons/$1/src/$2', | ||
'volto-slate/(.*)$': '<rootDir>/src/addons/volto-slate/src/$1', | ||
'@plone/volto-slate': | ||
'<rootDir>/node_modules/@plone/volto/packages/volto-slate/src', | ||
'~/(.*)$': '<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', | ||
'^.+\\.css$': 'jest-css-modules', | ||
'^.+\\.less$': 'jest-css-modules', | ||
'^.+\\.scss$': 'jest-css-modules', | ||
'^.+\\.(png)$': 'jest-file', | ||
@@ -26,0 +26,0 @@ '^.+\\.(jpg)$': 'jest-file', |
{ | ||
"name": "@eeacms/volto-resize-helper", | ||
"version": "0.2.10", | ||
"version": "1.0.0", | ||
"description": "@eeacms/volto-resize-helper: Volto add-on", | ||
@@ -21,4 +21,6 @@ "main": "src/index.js", | ||
"devDependencies": { | ||
"@cypress/code-coverage": "^3.9.5", | ||
"babel-plugin-transform-class-properties": "^6.24.1" | ||
"@plone/scripts": "*", | ||
"@cypress/code-coverage": "^3.10.0", | ||
"babel-plugin-transform-class-properties": "^6.24.1", | ||
"md5": "^2.3.0" | ||
}, | ||
@@ -30,12 +32,16 @@ "scripts": { | ||
"bootstrap": "npm install -g ejs; npm link ejs; node bootstrap", | ||
"stylelint": "../../../node_modules/stylelint/bin/stylelint.js --allow-empty-input 'src/**/*.{css,less}'", | ||
"stylelint:overrides": "../../../node_modules/.bin/stylelint --syntax less --allow-empty-input 'theme/**/*.overrides' 'src/**/*.overrides'", | ||
"stylelint:fix": "yarn stylelint --fix && yarn stylelint:overrides --fix", | ||
"prettier": "../../../node_modules/.bin/prettier --single-quote --check 'src/**/*.{js,jsx,json,css,less,md}'", | ||
"prettier:fix": "../../../node_modules/.bin/prettier --single-quote --write 'src/**/*.{js,jsx,json,css,less,md}'", | ||
"lint": "../../../node_modules/eslint/bin/eslint.js --max-warnings=0 'src/**/*.{js,jsx}'", | ||
"lint:fix": "../../../node_modules/eslint/bin/eslint.js --fix 'src/**/*.{js,jsx}'", | ||
"cypress:run": "../../../node_modules/cypress/bin/cypress run", | ||
"cypress:open": "../../../node_modules/cypress/bin/cypress open" | ||
"test": "make test", | ||
"test:fix": "make test-update", | ||
"pre-commit": "yarn stylelint:fix && yarn prettier:fix && yarn lint:fix", | ||
"stylelint": "make stylelint", | ||
"stylelint:overrides": "make stylelint-overrides", | ||
"stylelint:fix": "make stylelint-fix", | ||
"prettier": "make prettier", | ||
"prettier:fix": "make prettier-fix", | ||
"lint": "make lint", | ||
"lint:fix": "make lint-fix", | ||
"i18n": "make i18n", | ||
"cypress:run": "make cypress-run", | ||
"cypress:open": "make cypress-open" | ||
} | ||
} |
105
README.md
@@ -22,2 +22,3 @@ # volto-resize-helper | ||
### Usage | ||
After you add this add-on to your project, the viewport width and height are available as a global state in redux store. | ||
@@ -45,2 +46,3 @@ | ||
1. Start Plone backend | ||
``` | ||
@@ -64,21 +66,21 @@ docker run -d --name plone -p 8080:8080 -e SITE=Plone -e PROFILES="profile-plone.restapi:blocks" plone | ||
* If you already have a volto project, just update `package.json`: | ||
- If you already have a volto project, just update `package.json`: | ||
```JSON | ||
"addons": [ | ||
"@eeacms/volto-resize-helper" | ||
], | ||
```JSON | ||
"addons": [ | ||
"@eeacms/volto-resize-helper" | ||
], | ||
"dependencies": { | ||
"@eeacms/volto-resize-helper": "^1.0.0" | ||
} | ||
``` | ||
"dependencies": { | ||
"@eeacms/volto-resize-helper": "^1.0.0" | ||
} | ||
``` | ||
* If not, create one: | ||
- If not, create one: | ||
``` | ||
npm install -g yo @plone/generator-volto | ||
yo @plone/volto my-volto-project --addon @eeacms/volto-resize-helper | ||
cd my-volto-project | ||
``` | ||
``` | ||
npm install -g yo @plone/generator-volto | ||
yo @plone/volto my-volto-project --addon @eeacms/volto-resize-helper | ||
cd my-volto-project | ||
``` | ||
@@ -98,75 +100,4 @@ 1. Install new add-ons and restart Volto: | ||
### Automatic release using Jenkins | ||
See [RELEASE.md](https://github.com/eea/volto-resize-helper/blob/master/RELEASE.md). | ||
* The automatic release is started by creating a [Pull Request](../../compare/master...develop) from `develop` to `master`. The pull request status checks correlated to the branch and PR Jenkins jobs need to be processed successfully. 1 review from a github user with rights is mandatory. | ||
* It runs on every commit on `master` branch, which is protected from direct commits, only allowing pull request merge commits. | ||
* The automatic release is done by [Jenkins](https://ci.eionet.europa.eu). The status of the release job can be seen both in the Readme.md badges and the green check/red cross/yellow circle near the last commit information. If you click on the icon, you will have the list of checks that were run. The `continuous-integration/jenkins/branch` link goes to the Jenkins job execution webpage. | ||
* Automated release scripts are located in the `eeacms/gitflow` docker image, specifically [js-release.sh](https://github.com/eea/eea.docker.gitflow/blob/master/src/js-release.sh) script. It uses the `release-it` tool. | ||
* As long as a PR request is open from develop to master, the PR Jenkins job will automatically re-create the CHANGELOG.md and package.json files to be production-ready. | ||
* The version format must be MAJOR.MINOR.PATCH. By default, next release is set to next minor version (with patch 0). | ||
* You can manually change the version in `package.json`. The new version must not be already present in the tags/releases of the repository, otherwise it will be automatically increased by the script. Any changes to the version will trigger a `CHANGELOG.md` re-generation. | ||
* Automated commits and commits with [JENKINS] or [YARN] in the commit log are excluded from `CHANGELOG.md` file. | ||
### Manual release from the develop branch ( beta release ) | ||
#### Installation and configuration of release-it | ||
You need to first install the [release-it](https://github.com/release-it/release-it) client. | ||
``` | ||
npm install -g release-it | ||
``` | ||
Release-it uses the configuration written in the [`.release-it.json`](./.release-it.json) file located in the root of the repository. | ||
Release-it is a tool that automates 4 important steps in the release process: | ||
1. Version increase in `package.json` ( increased from the current version in `package.json`) | ||
2. `CHANGELOG.md` automatic generation from commit messages ( grouped by releases ) | ||
3. GitHub release on the commit with the changelog and package.json modification on the develop branch | ||
4. NPM release ( by default it's disabled, but can be enabled in the configuration file ) | ||
To configure the authentification, you need to export GITHUB_TOKEN for [GitHub](https://github.com/settings/tokens) | ||
``` | ||
export GITHUB_TOKEN=XXX-XXXXXXXXXXXXXXXXXXXXXX | ||
``` | ||
To configure npm, you can use the `npm login` command or use a configuration file with a TOKEN : | ||
``` | ||
echo "//registry.npmjs.org/:_authToken=YYYYYYYYYYYYYYYYYYYYYYYYYYYYYY" > .npmrc | ||
``` | ||
#### Using release-it tool | ||
There are 3 yarn scripts that can be run to do the release | ||
##### yarn release-beta | ||
Automatically calculates and presents 3 beta versions - patch, minor and major for you to choose ( or Other for manual input). | ||
``` | ||
? Select increment (next version): | ||
❯ prepatch (0.1.1-beta.0) | ||
preminor (0.2.0-beta.0) | ||
premajor (1.0.0-beta.0) | ||
Other, please specify... | ||
``` | ||
##### yarn release-major-beta | ||
Same as `yarn release-beta`, but with premajor version pre-selected. | ||
##### yarn release | ||
Generic command, does not automatically add the `beta` to version, but you can still manually write it if you choose Other. | ||
#### Important notes | ||
> Do not use release-it tool on master branch, the commit on CHANGELOG.md file and the version increase in the package.json file can't be done without a PULL REQUEST. | ||
> Do not keep Pull Requests from develop to master branches open when you are doing beta releases from the develop branch. As long as a PR to master is open, an automatic script will run on every commit and will update both the version and the changelog to a production-ready state - ( MAJOR.MINOR.PATCH mandatory format for version). | ||
## How to contribute | ||
@@ -173,0 +104,0 @@ |
Major refactor
Supply chain riskPackage has recently undergone a major refactor. It may be unstable or indicate significant internal changes. Use caution when updating to versions that include significant changes.
Found 1 instance in 1 package
No v1
QualityPackage is not semver >=1. This means it is not stable and does not support ^ ranges.
Found 1 instance in 1 package
0
25338
4
21
286
114
1