@s-ui/bundler 9.52.0 → 9.54.0-typescript-support.0

package/bin/sui-bundler-dev.js

@@ -57,7 +57,7 @@ if (!module.parent) {
 const start = async ({config = webpackConfig, packagesToLink = program.opts().linkPackage || []} = {}) => {
   clearConsole()
   // Warn and crash if required files are missing
-  if (!checkRequiredFiles([path.join(config.context, 'index.html'), path.join(config.context, 'app.js')])) {
+  if (!checkRequiredFiles([path.join(config.context, 'index.html')])) {
     log.error(`✖ Required files are missing, create and index.html and app.js inside your src folder.`)
     process.exit(1)
   }

package/loaders/linkLoaderConfigBuilder.js

@@ -43,7 +43,7 @@ module.exports = ({config, packagesToLink, linkAll}) => {
    * if neccesary
    */
   const linkLoader = {
-    test: /\.(jsx?|scss)$/,
+    test: /\.(jsx?|tsx?|scss)$/,
     enforce: 'pre', // this will ensure is execute before transformations
     use: {
       loader: require.resolve('./LinkLoader'),

package/package.json

@@ -1,57 +1 @@
-{
-  "name": "@s-ui/bundler",
-  "version": "9.52.0",
-  "description": "Config-free bundler for ES6 React apps.",
-  "bin": {
-    "sui-bundler": "./bin/sui-bundler.js"
-  },
-  "main": "./bin/sui-bundler.js",
-  "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
-  },
-  "keywords": [],
-  "author": "",
-  "license": "MIT",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/SUI-Components/sui.git"
-  },
-  "bugs": {
-    "url": "https://github.com/SUI-Components/sui/issues"
-  },
-  "homepage": "https://github.com/SUI-Components/sui/tree/master/packages/sui-bundler#readme",
-  "dependencies": {
-    "@babel/core": "7.18.10",
-    "@s-ui/helpers": "1",
-    "@s-ui/sass-loader": "1",
-    "address": "1.2.2",
-    "autoprefixer": "10.4.8",
-    "babel-loader": "8.2.5",
-    "babel-preset-sui": "3",
-    "buffer": "6.0.3",
-    "commander": "8.3.0",
-    "css-loader": "6.7.1",
-    "css-minimizer-webpack-plugin": "4.0.0",
-    "esbuild": "0.15.5",
-    "escape-string-regexp": "4.0.0",
-    "fast-glob": "3.2.11",
-    "find-free-ports": "3.0.0",
-    "html-webpack-plugin": "5.5.0",
-    "https-browserify": "1.0.0",
-    "mini-css-extract-plugin": "2.7.7",
-    "postcss": "8.4.31",
-    "postcss-loader": "7.0.1",
-    "process": "0.11.10",
-    "sass": "1.54.5",
-    "stream-http": "3.2.0",
-    "strip-ansi": "6.0.1",
-    "style-loader": "3.3.1",
-    "url": "0.11.0",
-    "webpack": "5.82.1",
-    "webpack-dev-server": "4.10.0",
-    "webpack-manifest-plugin": "5.0.0",
-    "webpack-node-externals": "3.0.0",
-    "@pmmmwh/react-refresh-webpack-plugin": "0.5.10",
-    "react-refresh": "0.14.0"
-  }
-}
+{"name":"@s-ui/bundler","version":"9.54.0-typescript-support.0","description":"Config-free bundler for ES6 React apps.","bin":{"sui-bundler":"./bin/sui-bundler.js"},"main":"./bin/sui-bundler.js","scripts":{"postinstall":"node ./scripts/postinstall.js","test":"echo \"Error: no test specified\" && exit 1"},"keywords":[],"author":"","license":"MIT","repository":{"type":"git","url":"git+https://github.com/SUI-Components/sui.git"},"bugs":{"url":"https://github.com/SUI-Components/sui/issues"},"homepage":"https://github.com/SUI-Components/sui/tree/master/packages/sui-bundler#readme","dependencies":{"@babel/core":"7.21.8","@s-ui/compiler-config":"1","@s-ui/helpers":"1","@s-ui/sass-loader":"1","@swc/core":"1.3.14","@swc/helpers":"0.4.12","address":"1.2.2","autoprefixer":"10.4.8","babel-loader":"8.2.5","babel-preset-sui":"3","buffer":"6.0.3","commander":"8.3.0","css-loader":"6.7.1","css-minimizer-webpack-plugin":"4.0.0","esbuild":"0.15.5","escape-string-regexp":"4.0.0","fast-glob":"3.2.12","find-free-ports":"3.0.0","html-webpack-plugin":"5.5.0","https-browserify":"1.0.0","mini-css-extract-plugin":"2.7.7","postcss":"8.4.31","postcss-loader":"7.3.4","process":"0.11.10","sass":"1.54.5","stream-http":"3.2.0","strip-ansi":"6.0.1","style-loader":"3.3.1","swc-loader":"0.2.1","url":"0.11.0","webpack":"5.82.1","webpack-dev-server":"4.10.0","webpack-manifest-plugin":"5.0.0","webpack-node-externals":"3.0.0","@pmmmwh/react-refresh-webpack-plugin":"0.5.10","react-refresh":"0.14.0"}}

package/scripts/postinstall.js

@@ -0,0 +1,48 @@
+#!/usr/bin/env node
+/* eslint-disable no-console */
+
+const crypto = require('crypto')
+const fs = require('fs-extra')
+const path = require('path')
+const {writeFile} = require('@s-ui/helpers/file.js')
+
+const {INIT_CWD} = process.env
+const tsConfigTemplate = `\
+{
+  "extends": "@s-ui/bundler/tsconfig.json",
+  "compilerOptions": {
+    "rootDir": "./"
+  },
+  "include": ["src", "domain", "components"]
+}`
+
+const md5 = str => crypto.createHash('md5').update(str).digest('hex')
+const TS_CONFIG_PATH = path.join(INIT_CWD, 'tsconfig.json')
+const PACKAGE_JSON_CONFIG_PATH = path.join(INIT_CWD, 'package.json')
+
+const config = require(PACKAGE_JSON_CONFIG_PATH)?.config?.['sui-bundler'] || {}
+
+const shouldGenerateTSConfig = () => {
+  try {
+    if (!config?.type || config?.type !== 'typescript') return false
+
+    if (!fs.existsSync(TS_CONFIG_PATH)) return true
+
+    const tsConfigLocal = fs.readFileSync(TS_CONFIG_PATH, {encoding: 'utf8'})
+    return md5(tsConfigLocal) !== md5(tsConfigTemplate)
+  } catch (err) {
+    return true
+  }
+}
+
+async function main() {
+  console.log('🔍 [sui-bundler postinstall] Checking if tsconfig.json is up to date...')
+  if (!shouldGenerateTSConfig()) {
+    console.log('✅ [sui-bundler postinstall] tsconfig.json is up to date')
+    process.exit(0)
+  }
+  await writeFile(TS_CONFIG_PATH, tsConfigTemplate)
+  console.log('❌ [sui-bundler postinstall] tsconfig.json was not up to date, so we updated it')
+}
+
+main()

package/shared/define.js

@@ -6,9 +6,23 @@ if (process.platform === 'win32') {
   process.env.PWD = process.cwd()
 }
 
-module.exports = (vars = {}) =>
-  new webpack.DefinePlugin({
+const {MAGIC_STRINGS = '{}'} = process.env
+
+let magic
+try {
+  magic = JSON.parse(MAGIC_STRINGS)
+} catch (err) {
+  magic = {}
+}
+
+module.exports = (vars = {}) => {
+  const definitions = {
     __DEV__: false,
     __BASE_DIR__: JSON.stringify(process.env.PWD),
-    ...vars
-  })
+    __MOCKS_API_PATH__: JSON.stringify(process.env.MOCKS_API_PATH || process.env.PWD + '/mocks/routes'),
+    ...vars,
+    ...Object.fromEntries(Object.entries(magic).map(([key, value]) => [key, JSON.stringify(value)]))
+  }
+
+  return new webpack.DefinePlugin(definitions)
+}

package/shared/index.js

@@ -1,6 +1,6 @@
 const {config} = require('./config.js')
 
-exports.MAIN_ENTRY_POINT = './app.js'
+exports.MAIN_ENTRY_POINT = './app'
 exports.config = config
 
 exports.cleanList = list => list.filter(Boolean)

package/shared/module-rules-compiler.js

@@ -0,0 +1,69 @@
+/* eslint-disable no-console */
+const fs = require('fs-extra')
+const path = require('path')
+const {config} = require('./index.js')
+const {getSWCConfig} = require('@s-ui/compiler-config')
+
+const EXCLUDED_FOLDERS_REGEXP = new RegExp(
+  `node_modules(?!${path.sep}@s-ui(${path.sep}studio)(${path.sep}workbench)?${path.sep}src)`
+)
+
+const getTSConfig = () => {
+  // Get TS config from the package dir.
+  const tsConfigPath = path.join(process.cwd(), 'tsconfig.json')
+  let tsConfig
+
+  try {
+    if (fs.existsSync(tsConfigPath)) {
+      tsConfig = JSON.parse(fs.readFileSync(tsConfigPath, {encoding: 'utf8'}))
+    }
+  } catch (err) {
+    console.error(err)
+  }
+
+  return tsConfig
+}
+
+module.exports = ({isServer = false, isDevelopment = false, supportLegacyBrowsers = true} = {}) => {
+  const tsConfig = getTSConfig()
+  // If TS config exists in root dir, set TypeScript as enabled.
+  const isTypeScriptEnabled = Boolean(tsConfig)
+
+  return isTypeScriptEnabled
+    ? {
+        test: /\.(js|ts)x?$/,
+        exclude: EXCLUDED_FOLDERS_REGEXP,
+        use: [
+          {
+            loader: require.resolve('swc-loader'),
+            options: getSWCConfig({isModern: false, isTypeScript: true})
+          }
+        ]
+      }
+    : {
+        test: /\.jsx?$/,
+        exclude: EXCLUDED_FOLDERS_REGEXP,
+        use: [
+          {
+            loader: require.resolve('babel-loader'),
+            options: {
+              cacheDirectory: true,
+              cacheCompression: false,
+              babelrc: false,
+              compact: true,
+              plugins: [isDevelopment && require.resolve('react-refresh/babel')].filter(Boolean),
+              presets: [
+                [
+                  require.resolve('babel-preset-sui'),
+                  {
+                    isServer,
+                    isModern: !supportLegacyBrowsers,
+                    targets: config.targets
+                  }
+                ]
+              ]
+            }
+          }
+        ]
+      }
+}

package/shared/resolve-alias.js

@@ -1,5 +1,6 @@
 const path = require('path')
 const {config} = require('./config.js')
+const fs = require('fs')
 
 const {PWD} = process.env
 
@@ -9,16 +10,33 @@ const {PWD} = process.env
  * So you should use the exact same imported file from node_modules, and the linked package
  * would try to use another different from its own node_modules. This will prevent that.
  */
-const defaultPackagesToAlias = ['react', 'react-router-dom', '@s-ui/pde', '@s-ui/react-context', '@s-ui/react-router']
+const defaultPackagesToAlias = [
+  'react',
+  'react-dom',
+  'react-router-dom',
+  'react/jsx-dev-runtime',
+  'react/jsx-runtime',
+  '@s-ui/pde',
+  '@s-ui/react-context',
+  '@s-ui/react-router'
+]
 
-const createAliasPath = pkgName => path.resolve(path.join(PWD, `./node_modules/${pkgName}`))
+const createAliasPath = pkgName => {
+  const PWDNodeModules = path.join(PWD, './node_modules')
+  if (fs.existsSync(PWDNodeModules)) return path.resolve(path.join(PWDNodeModules, pkgName))
 
-const mustPackagesToAlias = {
-  'react/jsx-dev-runtime': 'react/jsx-dev-runtime.js',
-  'react/jsx-runtime': 'react/jsx-runtime.js'
+  try {
+    return require.resolve(pkgName).replace(/\/index\.js$/, '')
+  } catch (e) {
+    return ''
+  }
 }
 
-exports.defaultAlias = Object.fromEntries(defaultPackagesToAlias.map(pkgName => [pkgName, createAliasPath(pkgName)]))
+const mustPackagesToAlias = {}
+
+exports.defaultAlias = Object.fromEntries(
+  defaultPackagesToAlias.map(pkgName => [pkgName, createAliasPath(pkgName)]).filter(([, path]) => path)
+)
 
 const aliasFromConfig = config.alias
   ? Object.entries(config.alias).reduce(

package/tsconfig.json

@@ -0,0 +1,3 @@
+{
+  "extends": "@s-ui/compiler-config/tsconfig.json"
+}

package/webpack.config.dev.js

@@ -12,7 +12,7 @@ const {aliasFromConfig, defaultAlias} = require('./shared/resolve-alias.js')
 const {supportLegacyBrowsers, cacheDirectory} = require('./shared/config.js')
 
 const {resolveLoader} = require('./shared/resolve-loader.js')
-const createBabelRules = require('./shared/module-rules-babel.js')
+const createCompilerRules = require('./shared/module-rules-compiler.js')
 
 const outputPath = path.join(process.cwd(), 'dist')
 
@@ -42,7 +42,7 @@ const webpackConfig = {
       timers: false
     },
     modules: ['node_modules', path.resolve(process.cwd())],
-    extensions: ['.js', '.json']
+    extensions: ['.js', '.tsx', '.ts', '.json']
   },
   stats: 'errors-only',
   entry: {
@@ -87,7 +87,7 @@ const webpackConfig = {
   resolveLoader,
   module: {
     rules: cleanList([
-      createBabelRules({supportLegacyBrowsers, isDevelopment: true}),
+      createCompilerRules({supportLegacyBrowsers, isDevelopment: true}),
       {
         test: /(\.css|\.scss)$/,
         use: cleanList([

package/webpack.config.lib.js

@@ -4,7 +4,7 @@ const {cleanList, envVars, MAIN_ENTRY_POINT, config} = require('./shared/index.j
 const path = require('path')
 const minifyJs = require('./shared/minify-js.js')
 const definePlugin = require('./shared/define.js')
-const createBabelRules = require('./shared/module-rules-babel.js')
+const createCompilerRules = require('./shared/module-rules-compiler.js')
 const sassRules = require('./shared/module-rules-sass.js')
 const {extractComments, sourceMap, supportLegacyBrowsers} = require('./shared/config.js')
 const {aliasFromConfig} = require('./shared/resolve-alias.js')
@@ -45,7 +45,7 @@ module.exports = {
   },
   plugins: cleanList([
     new webpack.ProvidePlugin({
-      process: 'process/browser'
+      process: 'process/browser.js'
     }),
     new MiniCssExtractPlugin({
       filename: cssFileName,
@@ -58,6 +58,6 @@ module.exports = {
     definePlugin()
   ]),
   module: {
-    rules: [createBabelRules({supportLegacyBrowsers}), sassRules]
+    rules: [createCompilerRules({supportLegacyBrowsers}), sassRules]
   }
 }

package/webpack.config.prod.js

@@ -13,7 +13,7 @@ const {when, cleanList, envVars, MAIN_ENTRY_POINT, config} = require('./shared/i
 const {aliasFromConfig} = require('./shared/resolve-alias.js')
 const {extractComments, sourceMap, supportLegacyBrowsers, cacheDirectory} = require('./shared/config.js')
 const {resolveLoader} = require('./shared/resolve-loader.js')
-const createBabelRules = require('./shared/module-rules-babel.js')
+const createCompilerRules = require('./shared/module-rules-compiler.js')
 const sassRules = require('./shared/module-rules-sass.js')
 const definePlugin = require('./shared/define.js')
 const manifestLoaderRules = require('./shared/module-rules-manifest-loader.js')
@@ -41,7 +41,7 @@ const webpackConfig = {
   context: path.resolve(CWD, 'src'),
   resolve: {
     alias: {...aliasFromConfig},
-    extensions: ['.js', '.json'],
+    extensions: ['.js', '.json', '.ts', '.tsx'],
     modules: ['node_modules', path.resolve(CWD)],
     fallback: {
       assert: false,
@@ -74,7 +74,7 @@ const webpackConfig = {
   },
   plugins: cleanList([
     new webpack.ProvidePlugin({
-      process: 'process/browser'
+      process: 'process/browser.js'
     }),
     new webpack.ids.HashedModuleIdsPlugin(),
     new webpack.EnvironmentPlugin(envVars(config.env)),
@@ -104,7 +104,7 @@ const webpackConfig = {
   ]),
   module: {
     rules: cleanList([
-      createBabelRules({supportLegacyBrowsers}),
+      createCompilerRules({supportLegacyBrowsers}),
       sassRules,
       when(config['externals-manifest'], () => manifestLoaderRules(config['externals-manifest']))
     ])

package/webpack.config.server.js

@@ -4,7 +4,7 @@ const path = require('path')
 
 const {config, when, cleanList} = require('./shared/index.js')
 const {cacheDirectory} = require('./shared/config.js')
-const createBabelRules = require('./shared/module-rules-babel.js')
+const createCompilerRules = require('./shared/module-rules-compiler.js')
 const manifestLoaderRules = require('./shared/module-rules-manifest-loader.js')
 const {aliasFromConfig} = require('./shared/resolve-alias.js')
 const {resolveLoader} = require('./shared/resolve-loader.js')
@@ -22,7 +22,7 @@ const webpackConfig = {
   mode: isProduction ? 'production' : 'development',
   resolve: {
     alias: {...aliasFromConfig},
-    extensions: ['.js', '.json'],
+    extensions: ['.js', '.json', '.ts', '.tsx'],
     modules: ['node_modules', path.resolve(process.cwd())]
   },
   entry: './server.js',
@@ -48,7 +48,7 @@ const webpackConfig = {
   resolveLoader,
   module: {
     rules: cleanList([
-      createBabelRules({isServer: true}),
+      createCompilerRules({isServer: true}),
       {
         // ignore css/scss/svg require/imports files in the server
         test: /(\.svg|\.s?css)$/,

package/shared/module-rules-babel.js

@@ -1,33 +0,0 @@
-const path = require('path')
-const {config} = require('./index.js')
-
-const EXCLUDED_FOLDERS_REGEXP = new RegExp(
-  `node_modules(?!${path.sep}@s-ui(${path.sep}studio)(${path.sep}workbench)?${path.sep}src)`
-)
-
-module.exports = ({isServer = false, isDevelopment = false, supportLegacyBrowsers = true} = {}) => ({
-  test: /\.jsx?$/,
-  exclude: EXCLUDED_FOLDERS_REGEXP,
-  use: [
-    {
-      loader: require.resolve('babel-loader'),
-      options: {
-        cacheDirectory: true,
-        cacheCompression: false,
-        babelrc: false,
-        compact: true,
-        plugins: [isDevelopment && require.resolve('react-refresh/babel')].filter(Boolean),
-        presets: [
-          [
-            require.resolve('babel-preset-sui'),
-            {
-              isServer,
-              isModern: !supportLegacyBrowsers,
-              targets: config.targets
-            }
-          ]
-        ]
-      }
-    }
-  ]
-})