@defra/flood-webchat 0.0.1-alpha.1 → 0.0.1-alpha.2

package/README.md

@@ -1,25 +1,9 @@
 # flood-webchat
 
-## Development
-A demo server with hot module reloading can be started at http://localhost:9000 by running:
+## Useful Links
+- [Development Guide](./docs/development-guide.md)
+- [How to Publish](./docs/how-to-publish.md)
 
-```shell
-npm run dev
-```
+## Usage
+TBC
 
-## How to Publish
-
-### A Pre-Release
-
-Via the GitHub GUI, create a release off your branch with a name matching a semver version pattern for the appropriate
-version with an added pre-release identifier, and check the pre-release identifier.
-For example if the latest published version was `v1.2.3` and you wish to publish a pre-release from your "cool-update"
-branch, name the release: `v1.2.4-cool-update.1`
-
-### A Release
-
-Via the GitHub GUI, create a release off the main branch with a name matching a semver version pattern with the
-appropriate version bump. For example if the latest published version was `v1.2.3` and you wish to release:
-- a patch update, the new release should be called `v1.2.4`
-- a minor update, the new release should be called `v1.3.0`
-- a major update, the new release should be called `v2.0.0`

package/docs/development-guide.md

@@ -0,0 +1,5 @@
+# Development Guide
+
+1) Clone the repo
+2) Run `npm install` to install the dependencies.
+3) Run `npm run dev` to run a demo server with hot module reloading on http://localhost:9000.

package/docs/how-to-publish.md

@@ -0,0 +1,41 @@
+# How to Publish
+
+This repo implements automated publishing via GitHub actions triggered by creating a release in GitHub.
+Releases should respect [the semantic versioning specification v2.0.0](https://semver.org/spec/v2.0.0.html).
+
+## A Pre-Release
+1) Go to the [GitHub repo homepage](https://github.com/DEFRA/flood-webchat) for this project.  
+2) Click "Create a new release"
+
+![](./assets/create-a-new-release.png)  
+
+3) Select your Target branch, by default it will be the "main" branch.  
+4) Click "Choose a Tag", enter a version tag with the appropriate semantic version bump and suffixed with a pre-release identifier and click "Create new tag". _(for example if the latest published version was `v1.2.3` and you wish to publish a pre-release from your "cool-update"
+   branch, name the release: `v1.2.4-cool-update.1`)_
+
+![](./assets/example-pre-release.png)
+
+5) Use your version name as a title, and add appropriate release notes in the description field.
+6) Tick the "Set as a pre-release" checkbox.
+7) Click "Publish release"
+8) A GitHub Action should then be triggered automatically, publishing your pre-release to npm.  
+9) You can install your pre-release into a consuming project by running `npm i @defra/flood-webchat@<version-number>`, e.g. `npm i @defra/flood-webchat@1.2.4-cool-update.1`.  
+
+_NOTE: pre-release identifiers must match the pattern `^-[0-9A-Za-z-].*$`_
+
+## A Release
+1) Go to the [GitHub repo homepage](https://github.com/DEFRA/flood-webchat) for this project.
+2) Click "Create a new release"
+
+![](./assets/create-a-new-release.png)
+
+3) Ensure that your Target branch is the "main" branch (this is the default).
+4) Click "Choose a Tag", enter a version tag with the appropriate semantic version bump.
+
+![](./assets/example-release.png)
+
+5) Use your version name as a title, and add appropriate release notes in the description field.
+6) Ensure that the "Set as a pre-release" checkbox is **NOT** checked.
+7) Click "Publish release"
+8) A GitHub Action should then be triggered automatically, publishing your release to npm.
+9) You can install your release into a consuming project by running `npm i @defra/flood-webchat@<version-number>`, e.g. `npm i @defra/flood-webchat@1.2.4`.

package/main.scss

@@ -0,0 +1,3 @@
+.defra-webchat-example {
+  color: blue;
+}

package/package.json

@@ -1,14 +1,17 @@
 {
   "name": "@defra/flood-webchat",
-  "version": "0.0.1-alpha.1",
+  "version": "0.0.1-alpha.2",
   "description": "",
-  "main": "src/main.mjs",
-  "browser": "src/browser.mjs",
+  "type": "module",
+  "main": "src/server/index.js",
+  "browser": "src/client/index.js",
   "scripts": {
     "test": "npm run lint && npm run unit-test",
     "dev": "(cd demo && webpack server)",
     "unit-test": "jest",
-    "lint": "standard",
+    "lint": "npm run lint:js && npm run lint:scss",
+    "lint:js": "standard",
+    "lint:scss": "stylelint \"**/*.scss\"",
     "prepare": "node -e \"try { require('husky').install() } catch (e) {if (e.code !== 'MODULE_NOT_FOUND') { throw e } }\""
   },
   "standard": {
@@ -38,6 +41,8 @@
     "sass": "^1.66.1",
     "sass-loader": "^13.3.2",
     "standard": "^17.1.0",
+    "stylelint": "^15.10.3",
+    "stylelint-config-standard-scss": "^10.0.0",
     "webpack": "^5.88.2",
     "webpack-cli": "^5.1.4",
     "webpack-dev-server": "^4.15.1"

package/src/server/index.js

@@ -0,0 +1,3 @@
+export function foo (value) {
+  return value === 'bar'
+}