shinkansen-pinion 1.0.72 → 1.0.75

package/README.md

@@ -1,10 +1,14 @@
 ## `shinkansen-pinion`
 
-# Shinkansen Pinion
+_Shinkansen_ generates JSON Schema valid documents from user submissions with `<html />` forms.
 
-*Pinion* implements components and transformers for Shinkansen using *Cogs* and *Sprockets*.
+# Pinion
+
+_Pinion_ implements components and transformers for integrating the the Zashiki description format with _Cogs_ and _Sprockets_.
+
+_Cogs_ and _Sprockets_ can be used in any React project but _Pinion_ connects them to Zashiki.
 
 ## See also
 
-- [Shinkansen Cogs](https://github.com/modernpoacher/shinkansen-cogs)
-- [Shinkansen Sprockets](https://github.com/modernpoacher/shinkansen-sprockets)
+- [Cogs](https://github.com/modernpoacher/shinkansen-cogs)
+- [Sprockets](https://github.com/modernpoacher/shinkansen-sprockets)

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "shinkansen-pinion",
-  "version": "1.0.72",
+  "version": "1.0.75",
   "description": "Shinkansen Pinion",
   "keywords": [
     "Shinkansen",
@@ -35,7 +35,9 @@
     "lint": "eslint . .storybook --ext .mjs --ext .cjs --ext .jsx --ext .mts --ext .cts",
     "lint:fix": "npm run lint -- --fix",
     "pretest": "npm run nvm",
-    "test": "cross-env NODE_ENV=test jest --collect-coverage false --verbose --run-in-band",
+    "test": "npm run test:mocha && npm run test:jest",
+    "test:mocha": "cross-env NODE_ENV=test mocha test --recursive",
+    "test:jest": "cross-env NODE_ENV=test jest --collect-coverage false --verbose --run-in-band",
     "nvm": "bash nvm.sh",
     "storybook": "npm run build && npm run transform && start-storybook -p 6009",
     "prepare": "husky install"
@@ -53,8 +55,8 @@
     "@babel/preset-env": "^7.21.5",
     "@babel/preset-react": "^7.18.6",
     "@babel/register": "^7.21.0",
-    "@modernpoacher/design-system": "1.0.7",
-    "@modernpoacher/hooks": "^1.0.397",
+    "@modernpoacher/design-system": "1.0.8",
+    "@modernpoacher/hooks": "^1.0.398",
     "@sequencemedia/gulp": "^1.0.7",
     "@storybook/addon-actions": "6.5.12",
     "@storybook/addon-essentials": "6.5.12",
@@ -65,6 +67,7 @@
     "@typescript-eslint/parser": "^5.59.5",
     "autoprefixer": "^10.4.14",
     "babel-plugin-module-resolver": "^5.0.0",
+    "chai": "^4.3.7",
     "core-js": "^3.30.2",
     "cross-env": "^7.0.3",
     "cssnano": "^6.0.1",
@@ -89,6 +92,7 @@
     "gulp-sourcemaps": "^3.0.0",
     "husky": "^8.0.3",
     "jest": "^29.5.0",
+    "mocha": "^10.2.0",
     "postcss": "^8.4.23",
     "postcss-easy-import": "^4.0.0",
     "postcss-map": "^0.11.0",
@@ -103,10 +107,12 @@
     "regenerator-runtime": "^0.13.11",
     "rimraf": "^5.0.0",
     "sass": "^1.62.1",
-    "shinkansen-cogs": "1.5.70",
+    "shinkansen-cogs": "1.5.71",
     "shinkansen-rails": "1.0.37",
     "shinkansen-signals": "1.1.20",
     "shinkansen-sprockets": "1.0.67",
+    "sinon": "^15.0.4",
+    "sinon-chai": "^3.7.0",
     "vinyl-paths": "^5.0.0"
   },
   "imports": {

package/src/components/index.mjs

@@ -7,4 +7,3 @@ log('`shinkansen` is awake')
 export { default as CheckAnswers } from './check-answers/index.cjs'
 export { default as ErrorSummary } from './error-summary/index.cjs'
 export { default as Fieldset } from './fieldset/index.cjs'
-export { default as Pinion } from '../pinion/index.cjs'

package/src/pinion/index.cjs

@@ -2,8 +2,12 @@ require('@babel/register')({ ignore: [] })
 
 const debug = require('debug')
 
+const {
+  default: component
+} = require('./index.jsx')
+
 const log = debug('shinkansen-pinion/pinion')
 
 log('`shinkansen` is awake')
 
-module.exports = require('./index.jsx')
+module.exports = component

package/test/components/check-answers/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import CheckAnswers from 'shinkansen-pinion/components/check-answers'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/components/check-answers', () => {
+  it('is an function', () => {
+    return expect(CheckAnswers)
+      .to.be.a('function')
+  })
+})

package/test/components/error-summary/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import ErrorSummary from 'shinkansen-pinion/components/error-summary'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/components/error-summary', () => {
+  it('is an function', () => {
+    return expect(ErrorSummary)
+      .to.be.a('function')
+  })
+})

package/test/components/fieldset/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import Fieldset from 'shinkansen-pinion/components/fieldset'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/components/fieldset', () => {
+  it('is an function', () => {
+    return expect(Fieldset)
+      .to.be.a('function')
+  })
+})

package/test/components/index.spec.mjs

@@ -0,0 +1,33 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import {
+  CheckAnswers,
+  ErrorSummary,
+  Fieldset
+} from 'shinkansen-pinion/components'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/components', () => {
+  describe('`CheckAnswers`', () => {
+    it('is a function', () => {
+      return expect(CheckAnswers)
+        .to.be.a('function')
+    })
+  })
+
+  describe('`ErrorSummary`', () => {
+    it('is a function', () => {
+      return expect(ErrorSummary)
+        .to.be.a('function')
+    })
+  })
+
+  describe('`Fieldset`', () => {
+    it('is a function', () => {
+      return expect(Fieldset)
+        .to.be.a('function')
+    })
+  })
+})

package/test/pinion/index.spec.mjs

@@ -0,0 +1,15 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import Pinion from 'shinkansen-pinion/pinion'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/pinion', () => {
+  describe('`Pinion`', () => {
+    it('is a function', () => {
+      return expect(Pinion)
+        .to.be.a('function')
+    })
+  })
+})

package/test/transformers/check-answers/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import * as checkAnswers from 'shinkansen-pinion/transformers/check-answers'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/transformers/check-answers', () => {
+  it('is a module', () => {
+    return expect(checkAnswers)
+      .to.be.a('module')
+  })
+})

package/test/transformers/common/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import * as common from 'shinkansen-pinion/transformers/common'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/transformers/common', () => {
+  it('is a module', () => {
+    return expect(common)
+      .to.be.a('module')
+  })
+})

package/test/transformers/error-message/index.spec.mjs

@@ -0,0 +1,13 @@
+import chai, { expect } from 'chai'
+import sinonChai from 'sinon-chai'
+
+import * as errorMessage from 'shinkansen-pinion/transformers/error-message'
+
+chai.use(sinonChai)
+
+describe('shinkansen-pinion/transformers/error-message', () => {
+  it('is a module', () => {
+    return expect(errorMessage)
+      .to.be.a('module')
+  })
+})