[Feature] TS implementation + Better types + ESM only (new official s…

…tandard) (#59)

* [Feature] TS implementation + Better types + ESM only (new official standard)

* [Fix] Review

.github/workflows/pull_request.yml

@@ -22,7 +22,7 @@ jobs:
           restore-keys: |
             ${{ runner.os }}-yarn-
 
-      - name: PascalCase
+      - name: Test
         run: |
           yarn
           yarn test

.gitignore

@@ -129,8 +129,7 @@ dist
 # .pnp.*
 
 .bin/
-cjs/
 esm/
 modules/
 public/
-index.d.ts
+types/

core.js → core.tsx

@@ -1,18 +1,26 @@
 import React, { cloneElement, createContext, useCallback, useRef, useState } from 'react'
 
 export const PictoContext = createContext({
-  optimise: (id, node) => node,
+  optimise: (id: string, node: React.ReactElement) => node,
   refresh: () => {},
 })
 
-export const PictoProvider = ({ children }) => {
+interface Cache {
+  [id: string]: React.ReactElement
+}
+
+interface PictoProviderProps {
+  children: React.ReactNode
+}
+
+export const PictoProvider = ({ children }: PictoProviderProps) => {
   const forceUpdate = useForceUpdate()
 
-  const cache = useRef({})
+  const cache = useRef<Cache>({})
   const isPending = useRef(false)
 
   const value = {
-    optimise(id, node) {
+    optimise(id: string, node: React.ReactElement) {
       if (!(id in cache.current)) {
         cache.current = { ...cache.current, [id]: node }
         isPending.current = true
@@ -46,7 +54,11 @@ export const PictoProvider = ({ children }) => {
   )
 }
 
-const Symbols = ({ cache }) => {
+interface SymbolsProps {
+  cache: React.MutableRefObject<Cache>
+}
+
+const Symbols = ({ cache }: SymbolsProps) => {
   const entries = Object.entries(cache.current)
 
   if (entries.length < 1) {
@@ -63,7 +75,7 @@ const Symbols = ({ cache }) => {
 }
 
 const useForceUpdate = () => {
-  const [, updateState] = useState()
+  const [, updateState] = useState<object>()
   const forceUpdate = useCallback(() => updateState({}), [])
 
   return forceUpdate

example/babel.config.js

@@ -0,0 +1,4 @@
+module.exports = {
+  plugins: ['babel-plugin-styled-components'],
+  presets: [['react-app', { runtime: 'automatic', typescript: true }]],
+}

example/global.d.ts

@@ -0,0 +1,5 @@
+declare global {
+  function __non_webpack_require__(pathname: string): any
+}
+
+export {}

example/package.json

@@ -2,27 +2,31 @@
   "name": "example",
   "author": "Sylvain Reucherand <sylvain@pretto.fr>",
   "devDependencies": {
-    "@babel/core": "^7.12.10",
+    "@babel/core": "^7.18.9",
     "@pretto/picto": "../",
-    "babel-loader": "^8.2.2",
-    "babel-plugin-styled-components": "^1.12.0",
-    "babel-preset-react-app": "^10.0.0",
-    "html-webpack-plugin": "^4.5.1",
-    "terser-webpack-plugin": "^5.1.1",
-    "webpack": "^5.17.0",
-    "webpack-bundle-analyzer": "^4.4.0",
-    "webpack-cli": "^4.4.0",
-    "webpack-dev-server": "^3.11.2",
-    "webpack-manifest-plugin": "^3.1.0"
+    "@types/react-dom": "^18.0.6",
+    "babel-loader": "^8.2.5",
+    "babel-plugin-styled-components": "^2.0.7",
+    "babel-preset-react-app": "^10.0.1",
+    "html-webpack-plugin": "^5.5.0",
+    "terser-webpack-plugin": "^5.3.3",
+    "typescript": "^4.7.4",
+    "webpack": "^5.73.0",
+    "webpack-bundle-analyzer": "^4.5.0",
+    "webpack-cli": "^4.10.0",
+    "webpack-dev-server": "^4.9.3",
+    "webpack-manifest-plugin": "^5.0.0"
   },
   "dependencies": {
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1",
-    "styled-components": "^5.2.1"
+    "@types/styled-components": "^5.1.25",
+    "react": "^18.2.0",
+    "react-dom": "^18.2.0",
+    "styled-components": "^5.3.5"
   },
   "scripts": {
     "build": "NODE_ENV=production webpack --config webpack.config.production.browser.js --progress",
     "start": "NODE_ENV=development webpack serve --config webpack.config.development.browser.js --progress",
-    "static": "NODE_ENV=production webpack --config webpack.config.production.static.js --progress && node .bin/index"
+    "static": "NODE_ENV=production webpack --config webpack.config.production.static.js --progress && node .bin/index",
+    "test": "tsc --noEmit"
   }
 }

example/src/App/index.js → example/src/App/index.tsx

@@ -1,10 +1,10 @@
-import { manifest, PictoProvider } from '@pretto/picto'
-import * as P from '@pretto/picto'
-import React, { createElement, useState } from 'react'
+import * as picto from '@pretto/picto'
+
+import { createElement, useState } from 'react'
 
 import * as S from './styles'
 
-const copy = value => {
+const copy = (value: string) => {
   const input = document.createElement('input')
 
   document.body.appendChild(input)
@@ -19,7 +19,9 @@ const copy = value => {
   return success
 }
 
-const App = () => {
+const { manifest, PictoProvider, ...P } = picto
+
+export const App = () => {
   const [isAllVisible, setIsAllVisible] = useState(false)
 
   const handleShowMoreClick = () => {
@@ -59,5 +61,3 @@ const App = () => {
     </PictoProvider>
   )
 }
-
-export default App

example/src/App/styles.js → example/src/App/styles.ts

@@ -1,6 +1,6 @@
 import styled, { createGlobalStyle } from 'styled-components'
 
-export const GlobalStyle = createGlobalStyle`
+export const GlobalStyle: any = createGlobalStyle`
   body {
     background-color: tomato;
     color: white;

example/src/index.browser.js → example/src/index.browser.tsx

@@ -1,7 +1,7 @@
 import React from 'react'
-import { hydrate, render } from 'react-dom'
+import { createRoot, hydrateRoot } from 'react-dom/client'
 
-import App from './App'
+import { App } from './App'
 
 const container = document.getElementById('__container')
 
@@ -10,7 +10,9 @@ if (!container) {
 
   document.body.appendChild(container)
 
-  render(<App />, container)
+  const root = createRoot(container)
+
+  root.render(<App />)
 } else {
-  hydrate(<App />, container)
+  hydrateRoot(container, <App />)
 }

example/src/index.static.js → example/src/index.static.tsx

@@ -1,11 +1,10 @@
-/* global __non_webpack_require__ */
 import fs from 'fs'
 import path from 'path'
 import React from 'react'
 import { renderToString } from 'react-dom/server'
 import { ServerStyleSheet } from 'styled-components'
 
-import App from './App'
+import { App } from './App'
 
 const manifest = __non_webpack_require__('./manifest.json')
 

example/tsconfig.json

@@ -0,0 +1,103 @@
+{
+  "compilerOptions": {
+    /* Visit https://aka.ms/tsconfig to read more about this file */
+
+    /* Projects */
+    // "incremental": true,                              /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
+    // "composite": true,                                /* Enable constraints that allow a TypeScript project to be used with project references. */
+    // "tsBuildInfoFile": "./.tsbuildinfo",              /* Specify the path to .tsbuildinfo incremental compilation file. */
+    // "disableSourceOfProjectReferenceRedirect": true,  /* Disable preferring source files instead of declaration files when referencing composite projects. */
+    // "disableSolutionSearching": true,                 /* Opt a project out of multi-project reference checking when editing. */
+    // "disableReferencedProjectLoad": true,             /* Reduce the number of projects loaded automatically by TypeScript. */
+
+    /* Language and Environment */
+    "target": "es5" /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */,
+    // "lib": [],                                        /* Specify a set of bundled library declaration files that describe the target runtime environment. */
+    "jsx": "react-jsx" /* Specify what JSX code is generated. */,
+    // "experimentalDecorators": true,                   /* Enable experimental support for TC39 stage 2 draft decorators. */
+    // "emitDecoratorMetadata": true,                    /* Emit design-type metadata for decorated declarations in source files. */
+    // "jsxFactory": "",                                 /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
+    // "jsxFragmentFactory": "",                         /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
+    // "jsxImportSource": "",                            /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
+    // "reactNamespace": "",                             /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
+    // "noLib": true,                                    /* Disable including any library files, including the default lib.d.ts. */
+    // "useDefineForClassFields": true,                  /* Emit ECMAScript-standard-compliant class fields. */
+    // "moduleDetection": "auto",                        /* Control what method is used to detect module-format JS files. */
+
+    /* Modules */
+    "module": "commonjs" /* Specify what module code is generated. */,
+    // "rootDir": "./",                                  /* Specify the root folder within your source files. */
+    // "moduleResolution": "node",                       /* Specify how TypeScript looks up a file from a given module specifier. */
+    // "baseUrl": "./",                                  /* Specify the base directory to resolve non-relative module names. */
+    // "paths": {},                                      /* Specify a set of entries that re-map imports to additional lookup locations. */
+    // "rootDirs": [],                                   /* Allow multiple folders to be treated as one when resolving modules. */
+    // "typeRoots": [],                                  /* Specify multiple folders that act like './node_modules/@types'. */
+    // "types": [],                                      /* Specify type package names to be included without being referenced in a source file. */
+    // "allowUmdGlobalAccess": true,                     /* Allow accessing UMD globals from modules. */
+    // "moduleSuffixes": [],                             /* List of file name suffixes to search when resolving a module. */
+    // "resolveJsonModule": true,                        /* Enable importing .json files. */
+    // "noResolve": true,                                /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
+
+    /* JavaScript Support */
+    // "allowJs": true,                                  /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
+    // "checkJs": true,                                  /* Enable error reporting in type-checked JavaScript files. */
+    // "maxNodeModuleJsDepth": 1,                        /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
+
+    /* Emit */
+    // "declaration": true,                              /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
+    // "declarationMap": true,                           /* Create sourcemaps for d.ts files. */
+    // "emitDeclarationOnly": true,                      /* Only output d.ts files and not JavaScript files. */
+    // "sourceMap": true,                                /* Create source map files for emitted JavaScript files. */
+    // "outFile": "./",                                  /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
+    // "outDir": "./",                                   /* Specify an output folder for all emitted files. */
+    // "removeComments": true,                           /* Disable emitting comments. */
+    // "noEmit": true,                                   /* Disable emitting files from a compilation. */
+    // "importHelpers": true,                            /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
+    // "importsNotUsedAsValues": "remove",               /* Specify emit/checking behavior for imports that are only used for types. */
+    // "downlevelIteration": true,                       /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
+    // "sourceRoot": "",                                 /* Specify the root path for debuggers to find the reference source code. */
+    // "mapRoot": "",                                    /* Specify the location where debugger should locate map files instead of generated locations. */
+    // "inlineSourceMap": true,                          /* Include sourcemap files inside the emitted JavaScript. */
+    // "inlineSources": true,                            /* Include source code in the sourcemaps inside the emitted JavaScript. */
+    // "emitBOM": true,                                  /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
+    // "newLine": "crlf",                                /* Set the newline character for emitting files. */
+    // "stripInternal": true,                            /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
+    // "noEmitHelpers": true,                            /* Disable generating custom helper functions like '__extends' in compiled output. */
+    // "noEmitOnError": true,                            /* Disable emitting files if any type checking errors are reported. */
+    // "preserveConstEnums": true,                       /* Disable erasing 'const enum' declarations in generated code. */
+    // "declarationDir": "./",                           /* Specify the output directory for generated declaration files. */
+    // "preserveValueImports": true,                     /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
+
+    /* Interop Constraints */
+    // "isolatedModules": true,                          /* Ensure that each file can be safely transpiled without relying on other imports. */
+    // "allowSyntheticDefaultImports": true,             /* Allow 'import x from y' when a module doesn't have a default export. */
+    "esModuleInterop": true /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */,
+    // "preserveSymlinks": true,                         /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
+    "forceConsistentCasingInFileNames": true /* Ensure that casing is correct in imports. */,
+
+    /* Type Checking */
+    "strict": true /* Enable all strict type-checking options. */,
+    // "noImplicitAny": true,                            /* Enable error reporting for expressions and declarations with an implied 'any' type. */
+    // "strictNullChecks": true,                         /* When type checking, take into account 'null' and 'undefined'. */
+    // "strictFunctionTypes": true,                      /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
+    // "strictBindCallApply": true,                      /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
+    // "strictPropertyInitialization": true,             /* Check for class properties that are declared but not set in the constructor. */
+    // "noImplicitThis": true,                           /* Enable error reporting when 'this' is given the type 'any'. */
+    // "useUnknownInCatchVariables": true,               /* Default catch clause variables as 'unknown' instead of 'any'. */
+    // "alwaysStrict": true,                             /* Ensure 'use strict' is always emitted. */
+    // "noUnusedLocals": true,                           /* Enable error reporting when local variables aren't read. */
+    // "noUnusedParameters": true,                       /* Raise an error when a function parameter isn't read. */
+    // "exactOptionalPropertyTypes": true,               /* Interpret optional property types as written, rather than adding 'undefined'. */
+    // "noImplicitReturns": true,                        /* Enable error reporting for codepaths that do not explicitly return in a function. */
+    // "noFallthroughCasesInSwitch": true,               /* Enable error reporting for fallthrough cases in switch statements. */
+    // "noUncheckedIndexedAccess": true,                 /* Add 'undefined' to a type when accessed using an index. */
+    // "noImplicitOverride": true,                       /* Ensure overriding members in derived classes are marked with an override modifier. */
+    // "noPropertyAccessFromIndexSignature": true,       /* Enforces using indexed accessors for keys declared using an indexed type. */
+    // "allowUnusedLabels": true,                        /* Disable error reporting for unused labels. */
+    // "allowUnreachableCode": true,                     /* Disable error reporting for unreachable code. */
+
+    /* Completeness */
+    // "skipDefaultLibCheck": true,                      /* Skip type checking .d.ts files that are included with TypeScript. */
+    "skipLibCheck": true /* Skip type checking all .d.ts files. */
+  }
+}

example/webpack.config.development.browser.js

@@ -8,10 +8,11 @@ const title = `${pkg.name} (v${pkg.version})`
 
 module.exports = {
   devServer: {
-    contentBase: path.join(__dirname, 'public'),
     historyApiFallback: true,
-    hot: true,
     port: 8765,
+    static: {
+      directory: path.join(__dirname, 'public'),
+    },
   },
 
   devtool: 'eval',
@@ -28,7 +29,7 @@ module.exports = {
         options: {
           cacheDirectory: true,
         },
-        test: /\.js$/,
+        test: /\.tsx?/,
       },
     ],
   },
@@ -48,5 +49,9 @@ module.exports = {
     }),
   ],
 
+  resolve: {
+    extensions: ['.js', '.jsx', '.json', '.ts', '.tsx'],
+  },
+
   stats: 'errors-warning',
 }

example/webpack.config.production.browser.js

@@ -21,7 +21,7 @@ module.exports = {
         options: {
           cacheDirectory: true,
         },
-        test: /\.js$/,
+        test: /\.tsx?$/,
       },
     ],
   },
@@ -44,6 +44,10 @@ module.exports = {
     }),
   ],
 
+  resolve: {
+    extensions: ['.js', '.jsx', '.json', '.ts', '.tsx'],
+  },
+
   stats: 'errors-warning',
 }