update: Doctypes api and verification (#13)

* update: Remove scripts since its not yet used

* update: New doctypes api and verification

Author: buames

.eslintrc.js

@@ -37,11 +37,5 @@ module.exports = {
         '@typescript-eslint/no-empty-function': 'off',
       },
     },
-    {
-      files: ['scripts/**/*'],
-      rules: {
-        'no-console': 'off',
-      },
-    },
   ],
 };

jest.config.js

@@ -1,5 +1,5 @@
 module.exports = {
-  collectCoverageFrom: ['packages/*/src/**/*.ts', 'scripts/**/*.ts'],
+  collectCoverageFrom: ['packages/*/src/**/*.ts'],
   coverageDirectory: 'coverage',
   coverageThreshold: {
     global: {
@@ -14,5 +14,5 @@ module.exports = {
   moduleNameMapper: {
     '@email-types/(.+)$': '<rootDir>/packages/$1',
   },
-  roots: ['<rootDir>/packages', '<rootDir>/scripts'],
+  roots: ['<rootDir>/packages'],
 };

package.json

@@ -9,8 +9,6 @@
     "clean": "rm -rf ./packages/*/{*.tsbuildinfo,dist}",
     "clean:prune": "rm -rf ./{,*/,**/*/}{node_modules,coverage,*.lock,*.log,*.tsbuildinfo,dist}",
     "build": "yarn clean && lerna run build --stream && yarn types",
-    "gen": "yarn run ts scripts/index.ts",
-    "ts": "ts-node --project ./tsconfig.node.json",
     "test": "yarn build && yarn lint && yarn jest:coverage",
     "jest": "jest --colors --logHeapUsage",
     "jest:coverage": "yarn run jest --coverage",
@@ -50,7 +48,6 @@
     "@types/prettier": "^1.19.0",
     "@typescript-eslint/eslint-plugin": "^2.7.0",
     "@typescript-eslint/parser": "^2.7.0",
-    "colors": "^1.4.0",
     "conventional-changelog-beemo": "^1.5.3",
     "eslint": "^6.6.0",
     "eslint-config-prettier": "^6.6.0",
@@ -65,10 +62,8 @@
     "jest": "^24.9.0",
     "lerna": "^3.18.4",
     "lint-staged": "^10.0.0-1",
-    "mri": "^1.1.4",
     "prettier": "^1.19.1",
     "react": "^16.12.0",
-    "ts-node": "^8.5.4",
     "typescript": "^3.7.2"
   },
   "keywords": [

packages/data/doctypes.d.ts

@@ -1 +1,2 @@
-export * from './dist/misc/doctypes';
+export * from './dist/html/doctypes';
+export * from './dist/html/doctypes.types';

packages/data/doctypes.js

@@ -1 +1 @@
-module.exports = require('./dist/misc/doctypes');
+module.exports = require('./dist/html/doctypes');

packages/data/src/common.ts

@@ -0,0 +1,4 @@
+export type Nullable<T> = T | null;
+
+/* Description value type */
+export type Description = string;

packages/data/src/misc/doctypes.ts packages/data/src/html/doctypes.tspackages/data/src/misc/doctypes.ts renamed to packages/data/src/html/doctypes.ts

@@ -1,56 +1,57 @@
-import { create } from '../utils/create';
-import { Doctype } from '../types/doctypes';
+import { Doctype } from './doctypes.types';
 
-const validate = create<Doctype>();
-
-export const doctypes = validate({
-  'html-5': {
+export const doctypes: Doctype[] = [
+  {
+    name: 'HTML 5',
     description:
       'A doctype declaration which is very short, due to its lack of references to a Document Type Definition (DTD) in the form of a URL or FPI. All it contains is the tag name of the root element of the document, HTML.',
     element: 'html',
     keyword: null,
     publicIdentifier: null,
     systemIdentifier: null,
   },
-  'html-4.01-strict': {
+  {
+    name: 'HTML 4.01 Strict',
     description:
       'A strict doctype declaration which validates against the HTML 4.01 spec, although it doesn\'t allow any presentational markup or deprecated elements (such as `<font>` elements) or framesets to be used. It validates loose HTML style markup, such as minimized attributes and non-quoted attributes (eg required, rather than required="required")',
     element: 'HTML',
     keyword: 'PUBLIC',
     publicIdentifier: '-//W3C//DTD HTML 4.01//EN',
     systemIdentifier: 'http://www.w3.org/TR/html4/strict.dtd',
   },
-  'html-4.01-transitional': {
+  {
+    name: 'HTML 4.01 Transitional',
     description:
       'A transitional doctype declaration which validates against the HTML 4.01 spec. It allows some presentational markup and deprecated elements (such as <font> elements) but not framesets. It validates loose HTML style markup, such as minimized attributes and non-quoted attributes (eg required, rather than required="required")',
     element: 'HTML',
     keyword: 'PUBLIC',
     publicIdentifier: '-//W3C//DTD HTML 4.01 Transitional//EN',
     systemIdentifier: 'http://www.w3.org/TR/html4/loose.dtd',
   },
-  'xhtml-1.1': {
+  {
+    name: 'XHTML 1.1',
     description: '',
     element: 'html',
     keyword: 'PUBLIC',
     publicIdentifier: '-//W3C//DTD XHTML 1.1//EN',
     systemIdentifier: 'http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd',
   },
-  'xhtml-1.0-strict': {
+  {
+    name: 'XHTML 1.0 Strict',
     description:
       "A strict doctype declaration which validates against the HTML 4.01 spec, although it doesn't allow any presentational markup or deprecated elements (such as `<font>` elements) or framesets to be used. Unlike the `HTML 4.01 Strict` doctype, it does not validate loose HTML style markup.",
     element: 'html',
     keyword: 'PUBLIC',
     publicIdentifier: '-//W3C//DTD XHTML 1.0 Strict//EN',
     systemIdentifier: 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd',
   },
-  'xhtml-1.0-transitional': {
+  {
+    name: 'XHTML 1.0 Transitional',
     description:
       'A transitional doctype declaration which validates against the HTML 4.01 spec. It allows some presentational markup and deprecated elements (such as <font> elements) but not framesets. Unlike the `HTML 4.01 Transitional` doctype, it does not validate loose HTML style markup.',
     element: 'html',
     keyword: 'PUBLIC',
     publicIdentifier: '-//W3C//DTD XHTML 1.0 Transitional//EN',
     systemIdentifier: 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd',
   },
-});
-
-export default doctypes;
+];

packages/data/src/html/doctypes.types.ts

@@ -0,0 +1,22 @@
+import { Nullable, Description } from '../common';
+
+type Name =
+  | 'HTML 5'
+  | 'HTML 4.01 Strict'
+  | 'HTML 4.01 Transitional'
+  | 'XHTML 1.1'
+  | 'XHTML 1.0 Strict'
+  | 'XHTML 1.0 Transitional';
+
+type Element = 'html' | 'HTML';
+
+type Keyword = 'PUBLIC' | 'SYSTEM';
+
+export type Doctype = {
+  name: Name;
+  description?: Description;
+  element: Element;
+  keyword: Nullable<Keyword>;
+  publicIdentifier: Nullable<string>;
+  systemIdentifier: Nullable<string>;
+};

packages/data/src/html/index.ts

@@ -0,0 +1,2 @@
+export * from './doctypes';
+export * from './doctypes.types';

packages/data/src/index.ts

@@ -1,3 +1,3 @@
 export * from './mso';
-export * from './misc/doctypes';
+export * from './html/doctypes';
 export * from './utils/create';