Merge pull request #1 from wmde/feat/initial-commit-cypress-wikibase-tasks-20240819

Add first Cypress tasks for basic API functionality

Author: codders

.eslintignore

@@ -0,0 +1,2 @@
+node_modules/
+package-lock.json

.eslintrc.json

@@ -0,0 +1,14 @@
+{
+	"extends": "wikimedia/server",
+	"env": {
+		"commonjs": true,
+		"es6": true,
+		"node": true
+	},
+	"parserOptions": {
+		"ecmaVersion": 2017
+	},
+	"rules": {
+		"max-len": [ "error", 120 ]
+	}
+}

CONTRIBUTING.md

@@ -0,0 +1,9 @@
+# Contributing
+
+## How to make a new Release
+
+1. Update version number in package.json (follow [Semantic Versioning](https://semver.org/)) in an extra commit
+1. Merge the Pull Request with that commit
+1. Tag the commit with the new version number on master locally and push the tag to GitHub
+1. On GitHub create a new "[Release](https://github.com/wmde/cypress-wikibase-api/releases)" for the tag with information on what changed
+1. GitHub actions will push the new Release to [npm](https://www.npmjs.com/package/cypress-wikibase-api)

README.md

@@ -1,2 +1,33 @@
 # cypress-wikibase-api
 Cypress plugin and utility functions for writing Cypress tests of Wikibase
+
+This module contains Cypress tasks to be used in Cypress browser tests for Wikibase and its extensions.
+
+## Usage example
+
+For example, in the Cypress tests in WikibaseLexeme, we use the API to get data about an entity that we created during our testing:
+
+```javascript
+lexemePage.headerId().then( ( lexemeId ) => {
+    cy.task( 'MwApi:GetEntityData', { entityId: lexemeId } ).then( ( lexeme ) => {
+	expect( lexeme.lemmas[ languageItemsLanguageCode ].value ).to.eq( lemma );
+	expect( lexeme.language ).to.eq( languageId );
+	expect( lexeme.lexicalCategory ).to.eq( lexicalCategoryId );
+    } );
+});
+```
+
+## Development
+
+When testing changes locally, you can install the checked-out module from the project that you are working on:
+
+```
+npm rm cypress-wikibase-api
+npm i -D ~/work/cypress-wikibase-api
+```
+
+## Contributing
+
+Please file any bugs or issues with our issue-tracker at [phabricator.wikimedia.org](https://phabricator.wikimedia.org/maniphest/task/edit/form/1/?tags=Wikidata,Browser-Tests).
+
+For instruction of how to create a new release, please see [CONTRIBUTING.md](CONTRIBUTING.md)