@davidsneighbour/cypress-config 3.5.9

package/LICENSE.md

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2022 Patrick Kollitsch / David's Neighbour
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

package/README.md

@@ -0,0 +1,65 @@
+## @davidsneighbour/cypress-config
+
+### Installation
+
+Use npm to install this package as development dependency:
+
+```shell
+npm install --save-dev @davidsneighbour/cypress-config
+```
+
+### Configuration
+
+Create `tests/cypress/plugins.index.js` with the following content:
+
+```js
+// noinspection JSUnresolvedVariable
+module.exports = (on, config) =>
+  // eslint-disable-next-line global-require
+  require("@davidsneighbour/cypress-config")(config.configFile);
+```
+
+Then add in `cypress.json` at least the following two lines:
+
+```json
+{
+  "extends": "@davidsneighbour/cypress-config/base.json",
+  "pluginsFile": "tests/cypress/plugins/index.js"
+}
+```
+
+This configuration setup uses the approach of [Gleb Bahmutov's blog post](https://www.cypress.io/blog/2020/06/18/extending-the-cypress-config-file/).
+
+## Default settings of this configuration
+
+- All cypress files reside within the `tests` directory (no need for additional directories in the root directory).
+- The base url is set to http://localhost:1313 - default for all Hugo dev server instances.
+- IDEs like IntelliJ import the schema to offer typeahead code hints.
+- `watchForFileChanges` is enabled.
+
+<!--- CONFIGURATIONS BEGIN --->
+
+## davidsneighbour/Configurations
+
+A collection of configurations for website development at DNB Org.
+
+<!-- prettier-ignore -->
+| Package | Description |
+| --- | ---- |
+| [babel-config](https://github.com/davidsneighbour/configurations/tree/main/packages/babel-config) | [Babel](https://babeljs.io/) configuration |
+| [bootstrap-config](https://github.com/davidsneighbour/configurations/tree/main/packages/bootstrap-config) | [Bootstrap](https://getbootstrap.com/) configuration |
+| [browserslist-config](https://github.com/davidsneighbour/configurations/tree/main/packages/browserslist-config) | [Browserslist](https://github.com/browserslist/browserslist) configuration |
+| [commitlint-config](https://github.com/davidsneighbour/configurations/tree/main/packages/commitlint-config) | [Commitlint](https://github.com/conventional-changelog/commitlint) configuration |
+| [cssnano-config](https://github.com/davidsneighbour/configurations/tree/main/packages/cssnano-config) | [CSSnano](https://cssnano.co/) configuration |
+| [cypress-config](https://github.com/davidsneighbour/configurations/tree/main/packages/cypress-config) | [Cypress](https://www.cypress.io/) configuration |
+| [eslint-config](https://github.com/davidsneighbour/configurations/tree/main/packages/eslint-config) | [ESLint](https://github.com/eslint/eslint) configuration |
+| [postcss-config](https://github.com/davidsneighbour/configurations/tree/main/packages/postcss-config) | [PostCSS](https://postcss.org/) configuration |
+| [prettier-config](https://github.com/davidsneighbour/configurations/tree/main/packages/prettier-config) | [Prettier](https://prettier.io/) configuration |
+| [remark-config](https://github.com/davidsneighbour/configurations/tree/main/packages/remark-config) | [ReMark](https://github.com/remarkjs/remark-lint) configuration |
+| [standard-version-config](https://github.com/davidsneighbour/configurations/tree/main/packages/standard-version-config) | [Standard Version](https://github.com/conventional-changelog/standard-version) configuration |
+| [stylelint-config](https://github.com/davidsneighbour/configurations/tree/main/packages/stylelint-config) | [StyleLint](https://github.com/stylelint/stylelint) configuration |
+| [textlint-config](https://github.com/davidsneighbour/configurations/tree/main/packages/textlint-config) | [TextLint](https://github.com/textlint/textlint) configuration |
+| [webpack-config](https://github.com/davidsneighbour/configurations/tree/main/packages/webpack-config) | [Webpack](https://webpack.js.org/) configuration |
+| [tools](https://github.com/davidsneighbour/configurations/tree/main/packages/tools) | Tools |
+
+<!--- CONFIGURATIONS END --->

package/base-hugo.json

@@ -0,0 +1,11 @@
+{
+  "baseUrl": "http://192.168.1.201:1313",
+  "$schema": "https://on.cypress.io/cypress.schema.json",
+  "watchForFileChanges": true,
+  "downloadsFolder": "tests/cypress/downloads",
+  "fixturesFolder": "tests/cypress/fixtures",
+  "integrationFolder": "tests/cypress/integration",
+  "screenshotsFolder": "tests/cypress/screenshots",
+  "supportFile": "tests/cypress/support/index.js",
+  "videosFolder": "tests/cypress/videos"
+}

package/base.json

@@ -0,0 +1,11 @@
+{
+  "baseUrl": "http://localhost:8888",
+  "$schema": "https://on.cypress.io/cypress.schema.json",
+  "watchForFileChanges": true,
+  "downloadsFolder": "tests/cypress/downloads",
+  "fixturesFolder": "tests/cypress/fixtures",
+  "integrationFolder": "tests/cypress/integration",
+  "screenshotsFolder": "tests/cypress/screenshots",
+  "supportFile": "tests/cypress/support/index.js",
+  "videosFolder": "tests/cypress/videos"
+}

package/index.js

@@ -0,0 +1,21 @@
+const deepmerge = require("deepmerge");
+const path = require("path");
+
+function loadConfig(filename) {
+  // console.log("reading config file %s", filename);
+  const configJson = require(filename);
+  if (configJson.extends) {
+    const baseConfigFilename = configJson.extends.startsWith(".")
+      ? path.join(path.dirname(filename), configJson.extends)
+      : require.resolve(configJson.extends);
+    // console.log("config file extends %s", baseConfigFilename);
+    const baseConfig = loadConfig(baseConfigFilename);
+    // console.log("merging %s with %s", baseConfigFilename, filename);
+    return deepmerge(baseConfig, configJson);
+  }
+  // console.log("config file %s does not extend", filename);
+  // console.log(configJson);
+  return configJson;
+}
+
+module.exports = loadConfig;

package/package.json

@@ -0,0 +1,34 @@
+{
+  "name": "@davidsneighbour/cypress-config",
+  "version": "3.5.9",
+  "license": "MIT",
+  "description": "Cypress configuration for davidsneighbour projects.",
+  "author": {
+    "name": "Patrick Kollitsch",
+    "email": "patrick@davids-neighbour.com",
+    "web": "https://davids-neighbour.com"
+  },
+  "repository": "git+https://github.com/davidsneighbour/configurations/",
+  "bugs": {
+    "url": "https://github.com/davidsneighbour/configurations/issues"
+  },
+  "dependencies": {
+    "axe-core": "^4.4.1",
+    "cypress": "^9.5.3",
+    "cypress-axe": "^0.14.0",
+    "debug": "^4.3.4",
+    "deepmerge": "^4.2.2",
+    "eslint-plugin-cypress": "^2.12.1"
+  },
+  "commitlint": {
+    "extends": [
+      "@davidsneighbour/commitlint-config"
+    ]
+  },
+  "engines": {
+    "node": ">=16",
+    "npm": ">=7"
+  },
+  "gitHead": "55c20949cd12651b0dfc600b5b316c8a42776506",
+  "main": "index.js"
+}