@nstudio/xplat-utils 16.5.0 → 16.5.2

package/README.md

@@ -22,24 +22,40 @@
 
 ## Quickstart
 
-```
+```sh
 npx create-nx-workspace@latest
 
-// Choose "Integrated monorepo" at the prompt:
+✔ Where would you like to create your workspace? · {your-workspace-name}
+
+# Choose "None"
+
+? Which stack do you want to use? … 
+None:          Configures a minimal structure without specific frameworks or technologies.
 
-? Choose what to create                 … 
-> Integrated monorepo:    Nx configures your favorite frameworks and lets you focus on shipping features.
+# Choose "Integrated"
+
+? Package-based or integrated? … 
+Integrated:    Nx creates a workspace structure most suitable for building apps.
+```
+
+### Init workspace
+
+Install the @nx/js plugin.
+
+```sh
+npm install @nx/js -D
+```
 
-// Choose "apps" at the prompt: 
+Now initialize -- This will ensure a `tsconfig.base.json` is created to begin building your workspace.
 
-? What to create in the new workspace   … 
-> apps              [an empty monorepo with no plugins with a layout that works best for building apps]
+```sh
+npx nx g @nx/js:init
 ```
 
-Install the tools:
+### Install the tools:
 
 ```
-npm i @nstudio/xplat -D
+npm install @nstudio/xplat -D
 ```
 
 You are now ready to create apps:
@@ -51,7 +67,7 @@ npx nx g @nstudio/xplat:app
 **NOTE:** If you encounter any issue, you can try creating an Nx workspace with version specified, for example:
 
 ```
-npx create-nx-workspace@14.1.7
+npx create-nx-workspace@16.5.0
 ```
 
 ## App generation examples

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@nstudio/xplat-utils",
-  "version": "16.5.0",
+  "version": "16.5.2",
   "description": "Utilities for xplat tooling.",
   "homepage": "https://nstudio.io/xplat",
   "repository": {

package/src/utils/utils.d.ts

@@ -4,7 +4,7 @@ export declare const supportedPlatforms: Array<PlatformTypes>;
 export declare const supportedNxExtraPlatforms: Array<PlatformNxExtraTypes>;
 export declare const supportedPlatformsWithNx: Array<PlatformWithNxTypes>;
 export declare const supportedFrameworks: Array<FrameworkTypes>;
-export declare function getNpmScope(): string;
+export declare function getNpmScope(tree?: NgTree): string;
 export declare function getPrefix(): string;
 export declare function getFrontendFramework(): "angular";
 export declare function getGroupByName(): boolean;
@@ -16,7 +16,6 @@ export declare function jsonParse(content: string): any;
 export declare function getJsonFromFile(tree: NgTree, path: string): any;
 export declare function updateJsonFile(tree: NgTree, path: string, jsonData: any): import("@angular-devkit/schematics/src/tree/interface").Tree;
 export declare function updateFile(tree: NgTree, path: string, content: string): import("@angular-devkit/schematics/src/tree/interface").Tree;
-export declare function getNxWorkspaceConfig(tree: NgTree): any;
 export declare const copy: (tree: NgTree, from: string, to: string) => void;
 export declare function getRootTsConfigPath(): string;
 export declare function getAppPaths(tree: NgTree, type?: PlatformTypes): Array<string>;

package/src/utils/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.toFileName = exports.parseProjectNameFromPath = exports.sanitizeCommaDelimitedArg = exports.prerun = exports.getAppPaths = exports.getRootTsConfigPath = exports.copy = exports.getNxWorkspaceConfig = exports.updateFile = exports.updateJsonFile = exports.getJsonFromFile = exports.jsonParse = exports.isTesting = exports.setTest = exports.isXplatWorkspace = exports.getAppName = exports.getGroupByName = exports.getFrontendFramework = exports.getPrefix = exports.getNpmScope = exports.supportedFrameworks = exports.supportedPlatformsWithNx = exports.supportedNxExtraPlatforms = exports.supportedPlatforms = void 0;
+exports.toFileName = exports.parseProjectNameFromPath = exports.sanitizeCommaDelimitedArg = exports.prerun = exports.getAppPaths = exports.getRootTsConfigPath = exports.copy = exports.updateFile = exports.updateJsonFile = exports.getJsonFromFile = exports.jsonParse = exports.isTesting = exports.setTest = exports.isXplatWorkspace = exports.getAppName = exports.getGroupByName = exports.getFrontendFramework = exports.getPrefix = exports.getNpmScope = exports.supportedFrameworks = exports.supportedPlatformsWithNx = exports.supportedNxExtraPlatforms = exports.supportedPlatforms = void 0;
 const schematics_1 = require("@angular-devkit/schematics");
 const devkit_1 = require("@nx/devkit");
 exports.supportedPlatforms = [
@@ -26,8 +26,22 @@ let frontendFramework;
 let groupByName = false;
 let isTest = false;
 let usingXplatWorkspace = false;
-function getNpmScope() {
-    return npmScope;
+function getNpmScope(tree) {
+    var _a;
+    if (npmScope) {
+        return npmScope;
+    }
+    const nxJson = getJsonFromFile(tree, 'nx.json');
+    // TODO(v17): Remove reading this from nx.json
+    if (nxJson.npmScope) {
+        npmScope = nxJson.npmScope;
+        return npmScope;
+    }
+    const packageJson = getJsonFromFile(tree, 'package.json');
+    if ((_a = packageJson === null || packageJson === void 0 ? void 0 : packageJson.name) === null || _a === void 0 ? void 0 : _a.startsWith('@')) {
+        npmScope = packageJson.name.split('/')[0].substring(1);
+        return npmScope;
+    }
 }
 exports.getNpmScope = getNpmScope;
 function getPrefix() {
@@ -105,18 +119,6 @@ function updateFile(tree, path, content) {
     }
 }
 exports.updateFile = updateFile;
-function getNxWorkspaceConfig(tree) {
-    const nxConfig = getJsonFromFile(tree, 'nx.json');
-    const hasWorkspaceDirs = tree.exists('apps') && tree.exists('libs');
-    // determine if Nx workspace
-    if (nxConfig) {
-        if (nxConfig.npmScope || hasWorkspaceDirs) {
-            return nxConfig;
-        }
-    }
-    throw new schematics_1.SchematicsException('@nstudio/xplat must be used inside an Nx workspace. Create a workspace first. https://nx.dev');
-}
-exports.getNxWorkspaceConfig = getNxWorkspaceConfig;
 const copy = (tree, from, to) => {
     const file = tree.get(from);
     if (!file) {
@@ -202,10 +204,7 @@ function getAppPaths(tree, type // by default, will return all app paths (consid
 exports.getAppPaths = getAppPaths;
 function prerun(options, init) {
     return (tree) => {
-        const nxJson = getNxWorkspaceConfig(tree);
-        if (nxJson) {
-            npmScope = nxJson.npmScope || 'workspace';
-        }
+        npmScope = getNpmScope(tree) || 'workspace';
         // console.log('npmScope:', npmScope);
         const packageJson = getJsonFromFile(tree, 'package.json');
         let frameworkChoice;