Release 14.0.0

Author: benm071

CONTRIBUTING.md

@@ -1,6 +1,6 @@
 # Contributing to ojet-cli
 
-*Copyright (c) 2014, 2022 Oracle and/or its affiliates
+*Copyright (c) 2014, 2023 Oracle and/or its affiliates
  Licensed under The Universal Permissive License (UPL), Version 1.0
  as shown at https://oss.oracle.com/licenses/upl/*
 

LICENSE

@@ -1,6 +1,6 @@
 # ojet-cli
 
-Copyright (c) 2022 Oracle and/or its affiliates.
+Copyright (c) 2023 Oracle and/or its affiliates.
 
 Licensed under The Universal Permissive License (UPL), Version 1.0
 as shown at https://oss.oracle.com/licenses/upl/

README.md

@@ -1,4 +1,4 @@
-# @oracle/ojet-cli 13.1.0
+# @oracle/ojet-cli 14.0.0
 
 ## About the module
 This module contains a command line interface for Oracle JET web and hybrid mobile application development.
@@ -64,11 +64,11 @@ Or view help on adding a plugin:
 ojet help add plugin
 ```
 
-For more information on the Oracle JET CLI, refer to the [Oracle JET Developers Guide](http://www.oracle.com/pls/topic/lookup?ctx=jet1310&id=homepage).
+For more information on the Oracle JET CLI, refer to the [Oracle JET Developers Guide](http://www.oracle.com/pls/topic/lookup?ctx=jet1400&id=homepage).
 
 ## [Contributing](https://github.com/oracle/ojet-cli/blob/master/CONTRIBUTING.md)
 Oracle JET is an open source project.  Pull Requests are currently not being accepted. See [CONTRIBUTING](https://github.com/oracle/ojet-cli/blob/master/CONTRIBUTING.md) for details.
 
 ## [License](https://github.com/oracle/ojet-cli/blob/master/LICENSE)
-Copyright (c) 2022 Oracle and/or its affiliates and released  under the 
+Copyright (c) 2023 Oracle and/or its affiliates and released  under the 
 [Universal Permissive License (UPL)](https://oss.oracle.com/licenses/upl/), Version 1.0

RELEASENOTES.md

@@ -1,11 +1,22 @@
 ## Release Notes for ojet-cli ##
 
+### 14.0.0
+* node-sass updated to 7.0.1
+* strict mode is now enabled by default in generated tsconfig.json files
+* oraclejet-serve.js and oraclejet-build.js are no longer read or processed.  Users should use other options in oraclejetconfig.json or the user hook system to set similar settings to what is found in oraclejet-serve.js and oraclejet-build.js.  The same configuration objects formerly found in oraclejet-serve.js and oraclejet-build.js can be found in the 'opts' section of the context object passed into the before_build and before_serve hooks.
+* Add a "before_injection" hook that runs after all copying but before output files are modified by injectors
+* Hybrid build/serve capability based on Cordova is deprecated as of 10.1.0 and is planned for removal in version 15.0.0
+* Add 'webpackLibraries' and 'typescriptLibraries' propety to oraclejetconfig.json to facilitate maintenance of third-party libraries needed by Webpack and Typescript, respectively
+* Update default typescript version to 4.8.4.  If you see a message warning about the wrong typescript version during build, please check your application's package.json to ensure that it is installing 4.8.4
+* When creating a vcomponent component, the template type now defaults to 'function' instead of 'class' if the value of the --vcomponent flag is not specified.
+* The CLI now installs itself within an application's node_modules for easy use of npx to issue ojet commands
+* A fix was made where the 'strict' typescript setting may not have been passed in to the compiler.  If a project sees new typescript compilation failures, 'strict' mode as set in tsconfig.json may be the issue
+
 ### 13.1.0
 
 * In index.html, the injected <script> type will be changed to 'module' for CDN bundle config loading if 'cdn' and 'bundles-config-esm.js' is selected in path_mapping.json, to support the new self-locating JET CDN bundle configuration file
 * Hybrid build/serve capability based on Cordova is deprecated as of 10.1.0 and is planned for removal in version 15.0.0
 
-
 ### 13.0.0
 
 * Metadata to support API documentation is now emitted for vcomponents during build

common/component.js

@@ -1,5 +1,5 @@
 /**
-  Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+  Copyright (c) 2015, 2023, Oracle and/or its affiliates.
   Licensed under The Universal Permissive License (UPL), Version 1.0
   as shown at https://oss.oracle.com/licenses/upl/
 
@@ -31,6 +31,7 @@ module.exports = {
       const componentThemeTemplateSrc = _getComponentThemeTemplatePath('theme');
       const componentDestDirectory = _getComponentDestPath(generator);
       const pack = generator.options.pack;
+      // eslint-disable-next-line max-len
       // avoid overwrite component
       if (fs.existsSync(componentDestDirectory)) {
         utils.log.error(`Component with name '${componentName}' already exists.`);
@@ -40,6 +41,28 @@ module.exports = {
       }
       fs.ensureDirSync(componentDestDirectory);
       fs.copySync(componentTemplateSrc, componentDestDirectory);
+      // Rename loader.ts in destination directory to index.ts for loaderless
+      // components--the contents are the same:
+      if (_isVComponent(generator) && !_withLoader({ generator, pack })) {
+        const loaderFilePath = path.join(componentDestDirectory, 'loader.ts');
+        const indexFilePath = path.join(componentDestDirectory, 'index.ts');
+        if (fs.existsSync(loaderFilePath)) {
+          fs.renameSync(loaderFilePath, indexFilePath);
+        }
+      }
+      // Loaderless components should have @ojmetadata main "@pack-name@/@component-name@"
+      // as part of the comment to ensure TSC inputs the main attribute into the component.json
+      // file with appropriate pack and component name. Otherwise, remove it.
+      if (_isVComponent(generator) && _withLoader({ generator, pack })) {
+        const filesToModify = ['@component@-functional-template.tsx', '@component@.tsx'];
+        filesToModify.forEach((file) => {
+          const filePath = path.join(componentDestDirectory, file);
+          const regex = /@ojmetadata\s*main\s*"@pack-name@\/@component-name@"/gm;
+          let fileContent = fs.readFileSync(filePath, { encoding: 'utf-8' });
+          fileContent = fileContent.replace(regex, '');
+          fs.writeFileSync(filePath, fileContent);
+        });
+      }
       if (_isResourceComponent(generator)) {
         const fileContent = constants.RESOURCE_COMPONENT_INDEX_FILE_CONTENT;
         fs.writeFileSync(path.join(componentDestDirectory, `index.${utils.isTypescriptApplication() ? 'ts' : 'js'}`), fileContent);
@@ -85,6 +108,7 @@ module.exports = {
   validateComponentName: (generator) => {
     const componentName = _getComponentName(generator);
     const pack = generator.options.pack;
+    // eslint-disable-next-line max-len
     let errorMessage;
     if (componentName === undefined || componentName === null) {
       errorMessage = 'Invalid component name: must not be null or undefined.';
@@ -101,6 +125,12 @@ module.exports = {
     } else if (pack && !fs.existsSync(_getPathToJETPack(generator, pack))) {
       errorMessage = 'Invalid pack name: please provide an existing JET pack';
       utils.log.error(errorMessage);
+    } else if (!pack && !_withLoader({ generator, pack }) && _isVComponent(generator)) {
+      errorMessage = 'Cannot create a loaderless component without a pack.';
+      utils.log.error(errorMessage);
+    } else if (!_withLoader({ generator, pack }) && !_isVComponent(generator)) {
+      errorMessage = 'Cannot create a loaderless CCA component.';
+      utils.log.error(errorMessage);
     }
   },
 
@@ -126,6 +156,10 @@ module.exports = {
    */
   logSuccessMessage: (generator) => {
     utils.log(commonMessages.appendJETPrefix(`Add component '${_getComponentName(generator)}' finished.`));
+    // Log out a message on what do to generate API docs for vcomponents only.
+    if (_isVComponent(generator)) {
+      utils.log(`To generate API docs for '${_getComponentName(generator)}', run 'ojet add docgen' before building it.`);
+    }
   },
 
   /**
@@ -359,8 +393,8 @@ function _renameComponentTemplatePrefixFile(componentDir, file, componentName) {
 /**
  * ## _updatePackInfo
  *
- * Add component to packs dependencies and set pack of component
- * to the provided pack
+ * Add component to packs dependencies (and contents, if monopack)
+ * and set pack of component to the provided pack
  *
  * @param {object} generator object with build options
  * @param {string} pack name of JET pack that the component belongs to
@@ -374,6 +408,10 @@ function _updatePackInfo({ generator, pack }) {
   }
   // add component to dependencies of pack
   _addComponentToPackDependencies({ generator, pack });
+  // add component to contents if pack is mono-pack:
+  if (_isMonoPack({ generator, pack })) {
+    _addComponentToPackContents({ generator, pack });
+  }
 }
 
 /**
@@ -393,7 +431,8 @@ function _updateVComponentPack({ generator, pack, strip }) {
     const packRegex = new RegExp('@ojmetadata pack "@pack-name@"');
     vComponentContent = vComponentContent.replace(packRegex, '');
   } else {
-    vComponentContent = vComponentContent.replace('@pack-name@', pack);
+    const packRegex = new RegExp('@pack-name@', 'g');
+    vComponentContent = vComponentContent.replace(packRegex, pack);
   }
   fs.outputFileSync(vComponentPath, vComponentContent);
 }
@@ -447,8 +486,8 @@ function _addComponentToPackDependencies({ generator, pack }) {
     constants.COMPONENT_JSON);
   const packComponentJson = fs.readJSONSync(packComponentJsonPath);
   const hasDependenciesToken = utils.loadToolingUtil().hasDependenciesToken(packComponentJson);
-  if (!hasDependenciesToken) {
-    // Only add component to dependnecies if the component.json does not have the dependencies
+  if (!hasDependenciesToken && !_isMonoPack({ generator, pack })) {
+    // Only add component to dependencies if the component.json does not have the dependencies
     // token. If it does, the build will take care of adding all JET pack dependencies at build time
     packComponentJson.dependencies = {
       ...(packComponentJson.dependencies || {}),
@@ -458,6 +497,27 @@ function _addComponentToPackDependencies({ generator, pack }) {
   }
 }
 
+/**
+ * ## _addComponentToPackContents
+ *
+ * @param {object} options.generator
+ * @param {object} options.pack
+ */
+function _addComponentToPackContents({ generator, pack }) {
+  const componentName = _getComponentName(generator);
+  const packComponentJsonPath = path.join(
+    _getPathToJETPack(generator, pack),
+    constants.COMPONENT_JSON);
+  const packComponentJson = fs.readJSONSync(packComponentJsonPath);
+  const contentItem = _isResourceComponent(generator) ? { name: `${componentName}`, type: constants.RESOURCE_COMPONENT } : { name: `${componentName}` };
+  if (packComponentJson.contents && Array.isArray(packComponentJson.contents)) {
+    packComponentJson.contents.push(contentItem);
+  } else {
+    packComponentJson.contents = [contentItem];
+  }
+  fs.writeJSONSync(packComponentJsonPath, packComponentJson, { spaces: 2 });
+}
+
 /**
  * ## _addComponentToTsconfigPathMapping
  *
@@ -508,11 +568,62 @@ function _isResourceComponent(generator) {
   return generator.options.type === constants.RESOURCE_COMPONENT;
 }
 
+/**
+ * ## _isMonoPack
+ *
+ * @param {object} options.generator
+ * @param {object} options.pack
+ * @returns {boolean}
+ */
+function _isMonoPack({ generator, pack }) {
+  if (pack) {
+    const packComponentJsonPath = path.join(
+      _getPathToJETPack(generator, pack),
+      constants.COMPONENT_JSON
+    );
+    const packComponentJson = fs.readJSONSync(packComponentJsonPath);
+    return packComponentJson.type === constants.MONO_PACK;
+  }
+  return false;
+}
+
+/**
+ * ## _withLoader
+ *
+ * @param {object} options.generator
+ * @param {object} options.pack
+ * @returns {boolean}
+ */
+function _withLoader({ generator, pack }) {
+  if (generator.options.withLoader === false ||
+     (_isMonoPack({ generator, pack }) && _isVComponent(generator))) {
+    // Ensure that the withLoader attribute in options object is false.
+    // This is because it can happen that the user creates the vcomponent
+    // in a mono-pack, which should default to a loaderless component, whether
+    // the withLoader flag is used or otherwise:
+    if (generator.options.withLoader === undefined) {
+      // eslint-disable-next-line no-param-reassign
+      generator.options.withLoader = false;
+    }
+    return generator.options.withLoader;
+  }
+  return true;
+}
+
+/**
+ * ## _filterTsxTemplates
+ *
+ * @param {object} generator object with build options
+ * @param {object} destPath
+ */
 function _filterTsxTemplates(generator, destPath) {
   const componentName = _getComponentName(generator);
   const pathToClassBasedTemplate = path.join(destPath, `${componentName}.tsx`);
   const pathToFunctionalBasedTemplate = path.join(destPath, `${componentName}-functional-template.tsx`);
-  if (generator.options.vcomponent === 'function' || generator.options.vcomponent === 'functional') {
+  if (generator.options.vcomponent === 'class') {
+    // do nothing--file begins as class based with root name
+  } else if (generator.options.vcomponent) {
+    // do function/functional by default
     // <componentName>.tsx now has functional based template after overwriting it
     // with <componentName-functional>.tsx contents. We need to do this because,
     // once the chosen template is vcomponent, then we need to use the functional

common/hookRunner.js

@@ -1,5 +1,5 @@
 /**
-  Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+  Copyright (c) 2015, 2023, Oracle and/or its affiliates.
   Licensed under The Universal Permissive License (UPL), Version 1.0
   as shown at https://oss.oracle.com/licenses/upl/
 

common/index.js

@@ -1,5 +1,5 @@
 /**
-  Copyright (c) 2015, 2022, Oracle and/or its affiliates.
+  Copyright (c) 2015, 2023, Oracle and/or its affiliates.
   Licensed under The Universal Permissive License (UPL), Version 1.0
   as shown at https://oss.oracle.com/licenses/upl/
 
@@ -33,46 +33,42 @@ module.exports =
   writeCommonTemplates: function _writeCommonTemplates(generator) {
     const templateSrc = path.resolve(__dirname, '../template/common');
     const templateDest = path.resolve('.');
-    return new Promise((resolve, reject) => {
-      function filter(src, dest) {
-        const isOracleJetConfigJson = path.basename(src) === constants.APP_CONFIG_JSON;
-        const isVDOMTemplate = utils.isVDOMTemplate(generator);
-        if (isVDOMTemplate && isOracleJetConfigJson) {
-          // for vdom templates, update the oracljetconfig.json to
-          // support the new architecture
-          const oraclejetConfigJson = fs.readJSONSync(src);
-          oraclejetConfigJson[constants.APPLICATION_ARCHITECTURE] = constants.VDOM_ARCHITECTURE;
-          oraclejetConfigJson.paths.source.javascript = '.';
-          oraclejetConfigJson.paths.source.typescript = '.';
-          oraclejetConfigJson.paths.source.styles = 'styles';
-          oraclejetConfigJson.paths.source.components = 'components';
-          oraclejetConfigJson.paths.source.exchangeComponents = 'exchange_components';
-          fs.writeJSONSync(dest, oraclejetConfigJson, { spaces: 2 });
-          return false;
-        } else if (isOracleJetConfigJson) {
-          // for none-vdom templates, update oraclejetconfig.json
-          // to indicate that architecture is mvvm (model-view-view-model)
-          const oraclejetConfigJson = fs.readJSONSync(src);
-          oraclejetConfigJson[constants.APPLICATION_ARCHITECTURE] = constants.MVVM_ARCHITECTURE;
-          fs.writeJSONSync(dest, oraclejetConfigJson, { spaces: 2 });
-          return false;
-        }
-        return true;
+    function filter(src, dest) {
+      const isOracleJetConfigJson = path.basename(src) === constants.APP_CONFIG_JSON;
+      const isVDOMTemplate = utils.isVDOMTemplate(generator);
+      if (isVDOMTemplate && isOracleJetConfigJson) {
+        // for vdom templates, update the oracljetconfig.json to
+        // support the new architecture
+        const oraclejetConfigJson = fs.readJSONSync(src);
+        oraclejetConfigJson[constants.APPLICATION_ARCHITECTURE] = constants.VDOM_ARCHITECTURE;
+        oraclejetConfigJson.paths.source.javascript = '.';
+        oraclejetConfigJson.paths.source.typescript = '.';
+        oraclejetConfigJson.paths.source.styles = 'styles';
+        oraclejetConfigJson.paths.source.components = 'components';
+        oraclejetConfigJson.paths.source.exchangeComponents = 'exchange_components';
+        fs.writeJSONSync(dest, oraclejetConfigJson, { spaces: 2 });
+        return false;
+      } else if (isOracleJetConfigJson) {
+        // for none-vdom templates, update oraclejetconfig.json
+        // to indicate that architecture is mvvm (model-view-view-model)
+        const oraclejetConfigJson = fs.readJSONSync(src);
+        oraclejetConfigJson[constants.APPLICATION_ARCHITECTURE] = constants.MVVM_ARCHITECTURE;
+        fs.writeJSONSync(dest, oraclejetConfigJson, { spaces: 2 });
+        return false;
       }
-      try {
-        fs.copySync(templateSrc, templateDest, { filter });
-        resolve();
-      } catch (error) {
-        reject(error);
-      }
-    });
+      return true;
+    }
+    try {
+      fs.copySync(templateSrc, templateDest, { filter });
+      return Promise.resolve();
+    } catch (error) {
+      return Promise.reject(error);
+    }
   },
 
   updatePackageJSON: function _updatePacakgeJSON(generator) {
-    return new Promise((resolve) => {
-      _updateJSON(generator, 'package.json');
-      resolve(generator);
-    });
+    _updateJSON(generator, 'package.json');
+    return Promise.resolve(generator);
   },
 
   validateAppDirNotExistsOrIsEmpty: function _validateAppDirNotExistsOrIsEmpty(generator) {
@@ -117,16 +113,13 @@ module.exports =
   },
 
   validateArgs: function _validateArgs(generator) {
-    return new Promise((resolve, reject) => {
-      const args = generator.arguments;
-      const validLength = _getValidArgLength(generator.options.namespace);
+    const args = generator.arguments;
+    const validLength = _getValidArgLength(generator.options.namespace);
 
-      if (args.length > validLength) {
-        reject(commonMessages.error(`Invalid additional arguments: ${args.splice(validLength)}`, 'validateArgs'));
-      } else {
-        resolve(generator);
-      }
-    });
+    if (args.length > validLength) {
+      return Promise.reject(commonMessages.error(`Invalid additional arguments: ${args.splice(validLength)}`, 'validateArgs'));
+    }
+    return Promise.resolve(generator);
   },
 
   validateFlags: function _validateFlags(generator) {
@@ -239,6 +232,8 @@ function _customizeVDOMTemplateTsconfigForWebpack() {
   tsconfigJson.compilerOptions.typeRoots.unshift('./types');
   tsconfigJson.compilerOptions.resolveJsonModule = true;
   tsconfigJson.compilerOptions.esModuleInterop = true;
+  tsconfigJson.compilerOptions.removeComments = true;
+  tsconfigJson.compilerOptions.strict = true;
   tsconfigJson.compilerOptions.paths.react = [
     preactCompat
   ];