create-near-app 4.0.0-beta.1.0 → 4.0.0

package/README.md

@@ -1,30 +1,28 @@
-create-near-app
+# Create NEAR App
 ===============
 [![Gitpod Ready-to-Code](https://img.shields.io/badge/Gitpod-Ready--to--Code-blue?logo=gitpod)](https://gitpod.io/#https://github.com/nearprotocol/create-near-app) 
 
 Quickly build apps backed by the [NEAR](https://near.org) blockchain
 
 
-Prerequisites
-=============
+## Prerequisites
 
 Make sure you have a [current version of Node.js](https://nodejs.org/en/about/releases/) installed – we are targeting versions `16+`.
 
 Read about other [prerequisites](https://docs.near.org/develop/prerequisites) in our docs.
 
-Getting Started
-===============
-
-To create a new NEAR project with default settings:
+## Getting Started
 
-Using [npm's npx](https://blog.npmjs.org/post/162869356040/introducing-npx-an-npm-package-runner):
+To create a new NEAR project run this and follow interactive prompts:
 
     npx create-near-app
 
+Follow the instructions in the README.md in the project you just created! 🚀
+
 You can create contracts written in:
 
-- [Rust](https://docs.near.org/develop/prerequisites)
 - [JavaScript](https://docs.near.org/develop/quickstart-guide)
+- [Rust](https://docs.near.org/develop/prerequisites)
 - AssemblyScript
 
 You can create a frontend template in:
@@ -32,31 +30,41 @@ You can create a frontend template in:
 - [React](https://reactjs.org/)
 - Vanilla JavaScript
 
+For testing we use a sandboxed environment of NEAR (called Workspaces).
+You can write the tests in JavaScript or Rust.
 
-Develop your own Dapp
-=====================
+### Using CLI arguments to run `create-near-app`
 
-Follow the instructions in the README.md in the project you just created! 🚀
+This CLI supports arguments to skip interactive prompts:
+
+```shell
+npx create-near-app
+  <project-name>
+  --contract js|rust|assemblyscript
+  --frontend vanilla|react|none
+  --tests js|rust
+  --install
+```
+
+Use `--install` to automatically install dependencies from all `package.json` files.
 
+When using arguments, all arguments are required, except for `--install`.
 
-Getting Help
-============
+## Getting Help
 
 Check out our [documentation](https://docs.near.org) or chat with us on [Discord](http://near.chat). We'd love to hear from you!
 
 
-Contributing
-============
+## Contributing to `create-near-app`
 
 To make changes to `create-near-app` itself:
 
 * clone the repository (Windows users, [use `git clone -c core.symlinks=true`](https://stackoverflow.com/a/42137273/249801))
 * in your terminal, enter one of the folders inside `templates`, such as `templates/vanilla`
-* now you can run `yarn` to install dependencies and `yarn dev` to run the local development server, just like you can in a new app created with `create-near-app`
+* now you can run `npm install` to install dependencies and `npm run dev` to run the local development server, just like you can in a new app created with `create-near-app`
 
 
-about commit messages
----------------------
+#### About commit messages
 
 `create-near-app` uses semantic versioning and auto-generates nice release notes & a changelog all based off of the commits. We do this by enforcing [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/). In general the pattern mostly looks like this:
 
@@ -73,8 +81,7 @@ Real world examples can look like this:
 If your change should show up in release notes as a feature, use `feat:`. If it should show up as a fix, use `fix:`. Otherwise, you probably want `refactor:` or `chore:`. [More info](https://github.com/conventional-changelog/commitlint/#what-is-commitlint)
 
 
-Deploy
-------
+#### Deploy `create-near-app`
 
 If you want to deploy a new version, you will need two prerequisites:
 
@@ -85,13 +92,12 @@ If you want to deploy a new version, you will need two prerequisites:
 
 Then run one script:
 
-    yarn release
+    npm run release
 
 Or just `release-it`
 
 
-License
-=======
+## License
 
 This repository is distributed under the terms of both the MIT license and the Apache License (Version 2.0).
 See [LICENSE](LICENSE) and [LICENSE-APACHE](LICENSE-APACHE) for details.

package/dist/app.js

@@ -1,74 +1,49 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 const path_1 = __importDefault(require("path"));
-const fs_1 = __importDefault(require("fs"));
 const make_1 = require("./make");
-const tracking_1 = require("./tracking");
-const semver_1 = __importDefault(require("semver"));
 const user_input_1 = require("./user-input");
-const messages_1 = require("./messages");
-(async function run() {
-    let config = null;
-    let configIsFromPrompts = false;
-    const args = await (0, user_input_1.getUserArgs)();
-    let { install } = args;
-    const argsValid = (0, user_input_1.validateUserArgs)(args);
-    // sanbox should be well supported by now, assemblyscript will be deprecated soon
-    // we explicitly take user's input: --no-sandbox => false, otherwise true
-    const supportsSandbox = args.sandbox;
-    if (argsValid === 'error') {
-        messages_1.show.argsError();
+const show = __importStar(require("./messages"));
+(async function () {
+    const promptResult = await (0, user_input_1.promptAndGetConfig)();
+    if (promptResult === null) {
         return;
     }
-    else if (argsValid === 'ok') {
-        config = args;
-    }
-    messages_1.show.welcome();
-    // Check node.js version
-    const current = process.version;
-    const supported = require('../package.json').engines.node;
-    if (!semver_1.default.satisfies(current, supported)) {
-        messages_1.show.unsupportedNodeVersion(supported);
-        // TODO: track unsupported versions
-        return;
-    }
-    // Get user input
-    if (config === null) {
-        const userInput = await (0, user_input_1.showUserPrompts)();
-        configIsFromPrompts = true;
-        if (!(0, user_input_1.userAnswersAreValid)(userInput)) {
-            throw new Error(`Invalid prompt. ${JSON.stringify(userInput)}`);
-        }
-        config = userInput;
-    }
-    const { frontend, contract, projectName } = config;
-    (0, tracking_1.trackUsage)(frontend, contract);
-    let projectPath = `${process.cwd()}/${projectName}`;
-    // If dir exists keep asking user
-    if (fs_1.default.existsSync(projectPath)) {
-        if (!configIsFromPrompts) {
-            messages_1.show.directoryExists(projectPath);
-            return;
-        }
-        else {
-            while (fs_1.default.existsSync(projectPath)) {
-                messages_1.show.directoryExists(projectPath);
-                const { projectName: newProjectName } = await (0, user_input_1.showProjectNamePrompt)();
-                projectPath = `${process.cwd()}/${newProjectName}`;
-            }
-        }
-    }
-    // Create the project
+    const { config: { projectName, contract, frontend, tests, install, }, projectPath, } = promptResult;
+    show.creatingApp();
     let createSuccess;
     try {
         createSuccess = await (0, make_1.createProject)({
             contract,
             frontend,
+            tests,
             projectName,
-            supportsSandbox,
             verbose: false,
             rootDir: path_1.default.resolve(__dirname, '../templates'),
             projectPath,
@@ -78,21 +53,15 @@ const messages_1 = require("./messages");
         console.error(e);
         createSuccess = false;
     }
+    if (install) {
+        await (0, make_1.runDepsInstall)(projectPath);
+    }
     if (createSuccess) {
-        messages_1.show.setupSuccess(projectPath, contract, frontend);
+        show.setupSuccess(projectPath, contract, frontend, install);
     }
     else {
-        messages_1.show.setupFailed();
+        show.setupFailed();
         return;
     }
-    if (install) {
-        await (0, make_1.runDepsInstall)(projectPath);
-    }
-    else if (configIsFromPrompts) {
-        const { depsInstall } = await (0, user_input_1.showDepsInstallPrompt)();
-        if (depsInstall) {
-            await (0, make_1.runDepsInstall)(projectPath);
-        }
-    }
 })();
 //# sourceMappingURL=app.js.map

package/dist/make.js

@@ -1,35 +1,48 @@
 "use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
 var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
 exports.runDepsInstall = exports.copyDir = exports.renameFile = exports.createFiles = exports.createProject = void 0;
-const messages_1 = require("./messages");
+const show = __importStar(require("./messages"));
 const cross_spawn_1 = __importDefault(require("cross-spawn"));
 const fs_1 = __importDefault(require("fs"));
 const ncp_1 = require("ncp");
 const path_1 = __importDefault(require("path"));
-const checks_1 = require("./checks");
 const package_json_1 = require("./package-json");
-// Method to create the project folder
-async function createProject({ contract, frontend, projectPath, projectName, verbose, rootDir, supportsSandbox }) {
-    // Make language specific checks
-    let preMessagePass = (0, checks_1.preMessage)({ contract, projectName, frontend, projectPath, verbose, rootDir, supportsSandbox });
-    if (!preMessagePass) {
-        return false;
-    }
-    messages_1.show.creatingApp();
+async function createProject({ contract, frontend, tests, projectPath, projectName, verbose, rootDir }) {
     // Create files in the project folder
-    await createFiles({ contract, frontend, projectName, projectPath, verbose, rootDir, supportsSandbox });
+    await createFiles({ contract, frontend, projectName, tests, projectPath, verbose, rootDir });
     // Create package.json
-    const packageJson = (0, package_json_1.buildPackageJson)({ contract, frontend, projectName, supportsSandbox });
+    const packageJson = (0, package_json_1.buildPackageJson)({ contract, frontend, tests, projectName });
     fs_1.default.writeFileSync(path_1.default.resolve(projectPath, 'package.json'), Buffer.from(JSON.stringify(packageJson, null, 2)));
-    // Run language-specific post check
-    (0, checks_1.postMessage)({ contract, frontend, projectName, projectPath, verbose, rootDir, supportsSandbox });
     return true;
 }
 exports.createProject = createProject;
-async function createFiles({ contract, frontend, projectPath, verbose, rootDir, supportsSandbox }) {
+async function createFiles({ contract, frontend, tests, projectPath, verbose, rootDir }) {
     // skip build artifacts and symlinks
     const skip = ['.cache', 'dist', 'out', 'node_modules'];
     // copy frontend
@@ -46,27 +59,20 @@ async function createFiles({ contract, frontend, projectPath, verbose, rootDir,
         verbose,
         skip: skip.map(f => path_1.default.join(contractSourceDir, f))
     });
-    // copy tests
-    const testFramework = supportsSandbox ? 'workspaces-tests' : 'classic-tests';
-    let sourceTestDir = `${rootDir}/integration-tests`;
-    if (supportsSandbox) {
-        switch (contract) {
-            case 'js':
-            case 'assemblyscript':
-                sourceTestDir = path_1.default.resolve(sourceTestDir, testFramework, 'ts');
-                break;
-            case 'rust':
-                sourceTestDir = path_1.default.resolve(sourceTestDir, 'workspaces-tests/rs');
-                break;
-        }
-    }
-    else {
-        sourceTestDir = path_1.default.resolve(sourceTestDir, 'classic-tests');
-    }
-    await copyDir(sourceTestDir, `${projectPath}/integration-tests/`, {
+    // copy tests - shared files
+    let sourceTestSharedDir = path_1.default.resolve(`${rootDir}/integration-tests/shared/${tests}-tests`);
+    await copyDir(sourceTestSharedDir, `${projectPath}/integration-tests/`, {
         verbose,
-        skip: skip.map(f => path_1.default.join(sourceTestDir, f))
+        skip: skip.map(f => path_1.default.join(sourceTestSharedDir, f))
     });
+    // copy tests - overrides files
+    let sourceTestOverridesDir = path_1.default.resolve(`${rootDir}/integration-tests/overrides/${contract}-contract/${tests}-tests`);
+    if (fs_1.default.existsSync(sourceTestOverridesDir)) {
+        await copyDir(sourceTestOverridesDir, `${projectPath}/integration-tests/`, {
+            verbose,
+            skip: skip.map(f => path_1.default.join(sourceTestOverridesDir, f))
+        });
+    }
     // add .gitignore
     await (0, exports.renameFile)(`${projectPath}/near.gitignore`, `${projectPath}/.gitignore`);
 }
@@ -112,14 +118,14 @@ function copyDir(source, dest, { skip, verbose }) {
 }
 exports.copyDir = copyDir;
 async function runDepsInstall(projectPath) {
-    messages_1.show.depsInstall();
-    const npmCommandArgs = ['deps-install'];
-    await new Promise((resolve, reject) => (0, cross_spawn_1.default)('yarn', npmCommandArgs, {
+    show.depsInstall();
+    const npmCommandArgs = ['run', 'deps-install'];
+    await new Promise((resolve, reject) => (0, cross_spawn_1.default)('npm', npmCommandArgs, {
         cwd: projectPath,
         stdio: 'inherit',
     }).on('close', (code) => {
         if (code !== 0) {
-            messages_1.show.depsInstallError();
+            show.depsInstallError();
             reject(code);
         }
         else {

package/dist/messages.js

@@ -3,44 +3,67 @@ var __importDefault = (this && this.__importDefault) || function (mod) {
     return (mod && mod.__esModule) ? mod : { "default": mod };
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.show = exports.log = void 0;
+exports.depsInstallError = exports.depsInstall = exports.creatingApp = exports.directoryExists = exports.windowsWarning = exports.unsupportedNodeVersion = exports.argsError = exports.setupSuccess = exports.successFrontendToText = exports.successContractToText = exports.setupFailed = exports.welcome = exports.show = void 0;
 const chalk_1 = __importDefault(require("chalk"));
 const tracking_1 = require("./tracking");
-const log = (...args) => console.log(...args);
-exports.log = log;
-const welcome = () => (0, exports.log)((0, chalk_1.default) `{blue ======================================================}
+if (process.env.NEAR_NO_COLOR) {
+    chalk_1.default.level = 0;
+}
+const show = (...args) => console.log(...args);
+exports.show = show;
+const welcome = () => (0, exports.show)((0, chalk_1.default) `{blue ======================================================}
 👋 {bold {green Welcome to NEAR!}} Learn more: https://docs.near.org/
 🔧 Let's get your dApp ready.
 {blue ======================================================}
 (${tracking_1.trackingMessage})
 `);
-const setupFailed = () => (0, exports.log)((0, chalk_1.default) `{bold {red ==========================================}}
+exports.welcome = welcome;
+const setupFailed = () => (0, exports.show)((0, chalk_1.default) `{bold {red ==========================================}}
 {red ⛔️ There was a problem during NEAR project setup}.
 Please refer to https://github.com/near/create-near-app README to troubleshoot.
 Notice: some platforms aren't supported (yet).
 {bold {red ==========================================}}`);
+exports.setupFailed = setupFailed;
 const successContractToText = (contract) => (0, chalk_1.default) `with a smart contract in {bold ${contract === 'rust' ? 'Rust' : contract === 'js' ? 'JavaScript' : 'AssemblyScript'}}`;
+exports.successContractToText = successContractToText;
 const successFrontendToText = (frontend) => frontend === 'none' ? '' : (0, chalk_1.default) ` and a frontend template${frontend === 'react' ? (0, chalk_1.default) `{bold  in React.js}` : ''}`;
-const setupSuccess = (projectName, contract, frontend) => (0, exports.log)((0, chalk_1.default) `
+exports.successFrontendToText = successFrontendToText;
+const setupSuccess = (projectName, contract, frontend, install) => (0, exports.show)((0, chalk_1.default) `
+{green ======================================================}
 ✅  Success! Created '${projectName}'
-   ${successContractToText(contract)}${successFrontendToText(frontend)}.
-🧠 See {bold {green README.md}} to get started.
-${contract === 'rust' ? (0, chalk_1.default) `🦀 If you are new to Rust please visit {bold {green https://www.rust-lang.org }}\n` : '\n'}
-Happy Hacking! 👍
-{blue ======================================================}`);
-const argsError = () => (0, exports.log)((0, chalk_1.default) `{red Arguments error}
+   ${(0, exports.successContractToText)(contract)}${(0, exports.successFrontendToText)(frontend)}.
+${contract === 'rust' ? (0, chalk_1.default) `🦀 If you are new to Rust please visit {bold {green https://www.rust-lang.org }}\n` : ''}
+  {bold {bgYellow {black Your next steps}}}:
+   - {inverse Navigate to your project}:
+         {blue cd {bold ${projectName}}}
+   ${!install ? (0, chalk_1.default) `- {inverse Install all dependencies}
+         {blue npm {bold run deps-install}}` : 'Then:'}
+   - {inverse Test your contract} in NEAR SandBox:
+         {blue npm {bold test}}
+   - {inverse Deploy your contract} to NEAR TestNet with a temporary dev account:
+         {blue npm {bold run deploy}}
+   ${frontend !== 'none' ? (0, chalk_1.default) `- {inverse Start your frontend}:
+         {blue npm {bold start}}\n` : ''}
+🧠 Read {bold {greenBright README.md}} to explore further.`);
+exports.setupSuccess = setupSuccess;
+const argsError = () => (0, exports.show)((0, chalk_1.default) `{red Arguments error}
 Run {blue npx create-near-app} without arguments, or use:
-npx create-near-app <projectName> --contract rust|js|assemblyscript --frontend react|vanilla|none`);
-const unsupportedNodeVersion = (supported) => (0, exports.log)((0, chalk_1.default) `{red We support node.js version ${supported} or later}`);
-const directoryExists = (dirName) => (0, exports.log)((0, chalk_1.default) `{red This directory already exists! ${dirName}}`);
-const creatingApp = () => (0, exports.log)((0, chalk_1.default) `...creating a new NEAR app...`);
-const depsInstall = () => (0, exports.log)((0, chalk_1.default) `
-{green Installing dependencies in a few folders, this might take a while...}
+npx create-near-app <projectName> --contract rust|js|assemblyscript --frontend react|vanilla|none --tests js|rust`);
+exports.argsError = argsError;
+const unsupportedNodeVersion = (supported) => (0, exports.show)((0, chalk_1.default) `{red We support node.js version ${supported} or later}`);
+exports.unsupportedNodeVersion = unsupportedNodeVersion;
+const windowsWarning = () => (0, exports.show)((0, chalk_1.default) `{bgYellow {black Notice: On Win32 please use WSL (Windows Subsystem for Linux).}}
+https://docs.microsoft.com/en-us/windows/wsl/install
+Exiting now.`);
+exports.windowsWarning = windowsWarning;
+const directoryExists = (dirName) => (0, exports.show)((0, chalk_1.default) `{red This directory already exists! ${dirName}}`);
+exports.directoryExists = directoryExists;
+const creatingApp = () => (0, exports.show)((0, chalk_1.default) `\nCreating a new {bold NEAR dApp}`);
+exports.creatingApp = creatingApp;
+const depsInstall = () => (0, exports.show)((0, chalk_1.default) `
+{green Installing dependencies in a few folders, this might take a while.}
 `);
-const depsInstallError = () => (0, exports.log)(chalk_1.default.red('Error installing NEAR project dependencies'));
-exports.show = {
-    welcome, setupFailed, setupSuccess, argsError,
-    unsupportedNodeVersion, directoryExists, creatingApp,
-    depsInstall, depsInstallError,
-};
+exports.depsInstall = depsInstall;
+const depsInstallError = () => (0, exports.show)(chalk_1.default.red('Error installing NEAR project dependencies'));
+exports.depsInstallError = depsInstallError;
 //# sourceMappingURL=messages.js.map