create-expo-module 0.0.0 → 0.1.0

package/.eslintrc.js

@@ -0,0 +1,2 @@
+// @generated by expo-module-scripts
+module.exports = require('expo-module-scripts/eslintrc.base.js');

package/README.md

@@ -0,0 +1 @@
+# create-expo-module

package/bin/create-expo-module

@@ -0,0 +1,3 @@
+#!/usr/bin/env node
+
+require('../build/create-expo-module.js')

package/build/create-expo-module.d.ts

@@ -0,0 +1 @@
+export {};

package/build/create-expo-module.js

@@ -0,0 +1,204 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const spawn_async_1 = __importDefault(require("@expo/spawn-async"));
+const commander_1 = require("commander");
+const download_tarball_1 = __importDefault(require("download-tarball"));
+const ejs_1 = __importDefault(require("ejs"));
+const fs_extra_1 = __importDefault(require("fs-extra"));
+const path_1 = __importDefault(require("path"));
+const prompts_1 = __importDefault(require("prompts"));
+const packageJson = require('../package.json');
+// `yarn run` may change the current working dir, then we should use `INIT_CWD` env.
+const CWD = process.env.INIT_CWD || process.cwd();
+// Ignore some paths. Especially `package.json` as it is rendered
+// from `$package.json` file instead of the original one.
+const IGNORES_PATHS = ['.DS_Store', 'build', 'node_modules', 'package.json'];
+/**
+ * The main function of the command.
+ *
+ * @param target Path to the directory where to create the module. Defaults to current working dir.
+ * @param command An object from `commander`.
+ */
+async function main(target, options) {
+    const targetDir = target ? path_1.default.join(CWD, target) : CWD;
+    options.target = targetDir;
+    await fs_extra_1.default.ensureDir(targetDir);
+    const packagePath = options.source
+        ? path_1.default.join(CWD, options.source)
+        : await downloadPackageAsync(targetDir);
+    const files = await getFilesAsync(packagePath);
+    const data = await askForSubstitutionDataAsync(targetDir, options);
+    // Iterate through all template files.
+    for (const file of files) {
+        const renderedRelativePath = ejs_1.default.render(file.replace(/^\$/, ''), data, {
+            openDelimiter: '{',
+            closeDelimiter: '}',
+            escape: (value) => value.replace('.', path_1.default.sep),
+        });
+        const fromPath = path_1.default.join(packagePath, file);
+        const toPath = path_1.default.join(targetDir, renderedRelativePath);
+        const template = await fs_extra_1.default.readFile(fromPath, { encoding: 'utf8' });
+        const renderedContent = ejs_1.default.render(template, data);
+        await fs_extra_1.default.outputFile(toPath, renderedContent, { encoding: 'utf8' });
+    }
+    if (!options.source) {
+        // Files in the downloaded tarball are wrapped in `package` dir.
+        // We should remove it after all.
+        await fs_extra_1.default.remove(packagePath);
+    }
+    if (!options.withReadme) {
+        await fs_extra_1.default.remove(path_1.default.join(targetDir, 'README.md'));
+    }
+    if (!options.withChangelog) {
+        await fs_extra_1.default.remove(path_1.default.join(targetDir, 'CHANGELOG.md'));
+    }
+    // Build TypeScript files.
+    await (0, spawn_async_1.default)('npm', ['run', 'build'], {
+        cwd: targetDir,
+    });
+}
+/**
+ * Recursively scans for the files within the directory. Returned paths are relative to the `root` path.
+ */
+async function getFilesAsync(root, dir = null) {
+    const files = [];
+    const baseDir = dir ? path_1.default.join(root, dir) : root;
+    for (const file of await fs_extra_1.default.readdir(baseDir)) {
+        const relativePath = dir ? path_1.default.join(dir, file) : file;
+        if (IGNORES_PATHS.includes(relativePath) || IGNORES_PATHS.includes(file)) {
+            continue;
+        }
+        const fullPath = path_1.default.join(baseDir, file);
+        const stat = await fs_extra_1.default.lstat(fullPath);
+        if (stat.isDirectory()) {
+            files.push(...(await getFilesAsync(root, relativePath)));
+        }
+        else {
+            files.push(relativePath);
+        }
+    }
+    return files;
+}
+/**
+ * Asks NPM registry for the url to the tarball.
+ */
+async function getNpmTarballUrl(packageName, version = 'latest') {
+    const { stdout } = await (0, spawn_async_1.default)('npm', ['view', `${packageName}@${version}`, 'dist.tarball']);
+    return stdout.trim();
+}
+/**
+ * Gets the username of currently logged in user. Used as a default in the prompt asking for the module author.
+ */
+async function npmWhoamiAsync(targetDir) {
+    try {
+        const { stdout } = await (0, spawn_async_1.default)('npm', ['whoami'], { cwd: targetDir });
+        return stdout.trim();
+    }
+    catch (e) {
+        return null;
+    }
+}
+/**
+ * Downloads the template from NPM registry.
+ */
+async function downloadPackageAsync(targetDir) {
+    const tarballUrl = await getNpmTarballUrl('expo-module-template');
+    await (0, download_tarball_1.default)({
+        url: tarballUrl,
+        dir: targetDir,
+    });
+    return path_1.default.join(targetDir, 'package');
+}
+/**
+ * Asks the user for some data necessary to render the template.
+ * Some values may already be provided by command options, the prompt is skipped in that case.
+ */
+async function askForSubstitutionDataAsync(targetDir, options) {
+    var _a, _b;
+    const defaultPackageSlug = path_1.default.basename(targetDir);
+    const defaultProjectName = defaultPackageSlug
+        .replace(/^./, (match) => match.toUpperCase())
+        .replace(/\W+(\w)/g, (_, p1) => p1.toUpperCase());
+    const promptQueries = [
+        {
+            type: 'text',
+            name: 'slug',
+            message: 'What is the package slug?',
+            initial: defaultPackageSlug,
+            resolvedValue: options.target ? defaultPackageSlug : null,
+        },
+        {
+            type: 'text',
+            name: 'name',
+            message: 'What is the project name?',
+            initial: defaultProjectName,
+        },
+        {
+            type: 'text',
+            name: 'description',
+            message: 'How would you describe the module?',
+        },
+        {
+            type: 'text',
+            name: 'package',
+            message: 'What is the Android package name?',
+            initial: `expo.modules.${defaultPackageSlug.replace(/\W/g, '').toLowerCase()}`,
+        },
+        {
+            type: 'text',
+            name: 'author',
+            message: 'Who is the author?',
+            initial: (_a = (await npmWhoamiAsync(targetDir))) !== null && _a !== void 0 ? _a : '',
+        },
+        {
+            type: 'text',
+            name: 'license',
+            message: 'What is the license?',
+            initial: 'MIT',
+        },
+        {
+            type: 'text',
+            name: 'repo',
+            message: 'What is the repository URL?',
+        },
+    ];
+    const answers = {};
+    for (const query of promptQueries) {
+        const { name, resolvedValue } = query;
+        answers[name] = (_b = resolvedValue !== null && resolvedValue !== void 0 ? resolvedValue : options[name]) !== null && _b !== void 0 ? _b : (await (0, prompts_1.default)(query))[name];
+    }
+    const { slug, name, description, package: projectPackage, author, license, repo } = answers;
+    return {
+        project: {
+            slug,
+            name,
+            version: '0.1.0',
+            description,
+            package: projectPackage,
+        },
+        author,
+        license,
+        repo,
+    };
+}
+const program = new commander_1.Command();
+program
+    .name(packageJson.name)
+    .version(packageJson.version)
+    .description(packageJson.description)
+    .arguments('[target_dir]')
+    .option('-s, --source <source_dir>', 'Local path to the template. By default it downloads `expo-module-template` from NPM.')
+    .option('-n, --name <module_name>', 'Name of the native module.')
+    .option('-d, --description <description>', 'Description of the module.')
+    .option('-p, --package <package>', 'The Android package name.')
+    .option('-a, --author <author>', 'The author name.')
+    .option('-l, --license <license>', 'The license that the module is distributed with.')
+    .option('-r, --repo <repo_url>', 'The URL to the repository.')
+    .option('--with-readme', 'Whether to include README.md file.', false)
+    .option('--with-changelog', 'Whether to include CHANGELOG.md file.', false)
+    .action(main);
+program.parse(process.argv);
+//# sourceMappingURL=create-expo-module.js.map

package/build/create-expo-module.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"create-expo-module.js","sourceRoot":"","sources":["../src/create-expo-module.ts"],"names":[],"mappings":";;;;;AAAA,oEAA2C;AAC3C,yCAAoC;AACpC,wEAA+C;AAC/C,8CAAsB;AACtB,wDAA0B;AAC1B,gDAAwB;AACxB,sDAAgD;AAEhD,MAAM,WAAW,GAAG,OAAO,CAAC,iBAAiB,CAAC,CAAC;AAE/C,oFAAoF;AACpF,MAAM,GAAG,GAAG,OAAO,CAAC,GAAG,CAAC,QAAQ,IAAI,OAAO,CAAC,GAAG,EAAE,CAAC;AAElD,iEAAiE;AACjE,yDAAyD;AACzD,MAAM,aAAa,GAAG,CAAC,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,cAAc,CAAC,CAAC;AAuC7E;;;;;GAKG;AACH,KAAK,UAAU,IAAI,CAAC,MAA0B,EAAE,OAAuB;IACrE,MAAM,SAAS,GAAG,MAAM,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC;IAExD,OAAO,CAAC,MAAM,GAAG,SAAS,CAAC;IAC3B,MAAM,kBAAE,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC;IAE9B,MAAM,WAAW,GAAG,OAAO,CAAC,MAAM;QAChC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,OAAO,CAAC,MAAM,CAAC;QAChC,CAAC,CAAC,MAAM,oBAAoB,CAAC,SAAS,CAAC,CAAC;IAC1C,MAAM,KAAK,GAAG,MAAM,aAAa,CAAC,WAAW,CAAC,CAAC;IAC/C,MAAM,IAAI,GAAG,MAAM,2BAA2B,CAAC,SAAS,EAAE,OAAO,CAAC,CAAC;IAEnE,sCAAsC;IACtC,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE;QACxB,MAAM,oBAAoB,GAAG,aAAG,CAAC,MAAM,CAAC,IAAI,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,EAAE,IAAI,EAAE;YACrE,aAAa,EAAE,GAAG;YAClB,cAAc,EAAE,GAAG;YACnB,MAAM,EAAE,CAAC,KAAa,EAAE,EAAE,CAAC,KAAK,CAAC,OAAO,CAAC,GAAG,EAAE,cAAI,CAAC,GAAG,CAAC;SACxD,CAAC,CAAC;QACH,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,WAAW,EAAE,IAAI,CAAC,CAAC;QAC9C,MAAM,MAAM,GAAG,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,oBAAoB,CAAC,CAAC;QAC1D,MAAM,QAAQ,GAAG,MAAM,kBAAE,CAAC,QAAQ,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;QACnE,MAAM,eAAe,GAAG,aAAG,CAAC,MAAM,CAAC,QAAQ,EAAE,IAAI,CAAC,CAAC;QAEnD,MAAM,kBAAE,CAAC,UAAU,CAAC,MAAM,EAAE,eAAe,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;KACpE;IAED,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE;QACnB,gEAAgE;QAChE,iCAAiC;QACjC,MAAM,kBAAE,CAAC,MAAM,CAAC,WAAW,CAAC,CAAC;KAC9B;IACD,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;QACvB,MAAM,kBAAE,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,WAAW,CAAC,CAAC,CAAC;KACpD;IACD,IAAI,CAAC,OAAO,CAAC,aAAa,EAAE;QAC1B,MAAM,kBAAE,CAAC,MAAM,CAAC,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,cAAc,CAAC,CAAC,CAAC;KACvD;IAED,0BAA0B;IAC1B,MAAM,IAAA,qBAAU,EAAC,KAAK,EAAE,CAAC,KAAK,EAAE,OAAO,CAAC,EAAE;QACxC,GAAG,EAAE,SAAS;KACf,CAAC,CAAC;AACL,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,aAAa,CAAC,IAAY,EAAE,MAAqB,IAAI;IAClE,MAAM,KAAK,GAAa,EAAE,CAAC;IAC3B,MAAM,OAAO,GAAG,GAAG,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;IAElD,KAAK,MAAM,IAAI,IAAI,MAAM,kBAAE,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE;QAC5C,MAAM,YAAY,GAAG,GAAG,CAAC,CAAC,CAAC,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;QAEvD,IAAI,aAAa,CAAC,QAAQ,CAAC,YAAY,CAAC,IAAI,aAAa,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE;YACxE,SAAS;SACV;QAED,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,OAAO,EAAE,IAAI,CAAC,CAAC;QAC1C,MAAM,IAAI,GAAG,MAAM,kBAAE,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC;QAEtC,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE;YACtB,KAAK,CAAC,IAAI,CAAC,GAAG,CAAC,MAAM,aAAa,CAAC,IAAI,EAAE,YAAY,CAAC,CAAC,CAAC,CAAC;SAC1D;aAAM;YACL,KAAK,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC;SAC1B;KACF;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,gBAAgB,CAAC,WAAmB,EAAE,UAAkB,QAAQ;IAC7E,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,qBAAU,EAAC,KAAK,EAAE,CAAC,MAAM,EAAE,GAAG,WAAW,IAAI,OAAO,EAAE,EAAE,cAAc,CAAC,CAAC,CAAC;IAClG,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;AACvB,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,cAAc,CAAC,SAAiB;IAC7C,IAAI;QACF,MAAM,EAAE,MAAM,EAAE,GAAG,MAAM,IAAA,qBAAU,EAAC,KAAK,EAAE,CAAC,QAAQ,CAAC,EAAE,EAAE,GAAG,EAAE,SAAS,EAAE,CAAC,CAAC;QAC3E,OAAO,MAAM,CAAC,IAAI,EAAE,CAAC;KACtB;IAAC,OAAO,CAAC,EAAE;QACV,OAAO,IAAI,CAAC;KACb;AACH,CAAC;AAED;;GAEG;AACH,KAAK,UAAU,oBAAoB,CAAC,SAAiB;IACnD,MAAM,UAAU,GAAG,MAAM,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;IAElE,MAAM,IAAA,0BAAe,EAAC;QACpB,GAAG,EAAE,UAAU;QACf,GAAG,EAAE,SAAS;KACf,CAAC,CAAC;IACH,OAAO,cAAI,CAAC,IAAI,CAAC,SAAS,EAAE,SAAS,CAAC,CAAC;AACzC,CAAC;AAED;;;GAGG;AACH,KAAK,UAAU,2BAA2B,CACxC,SAAiB,EACjB,OAAuB;;IAEvB,MAAM,kBAAkB,GAAG,cAAI,CAAC,QAAQ,CAAC,SAAS,CAAC,CAAC;IACpD,MAAM,kBAAkB,GAAG,kBAAkB;SAC1C,OAAO,CAAC,IAAI,EAAE,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,WAAW,EAAE,CAAC;SAC7C,OAAO,CAAC,UAAU,EAAE,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,CAAC,EAAE,CAAC,WAAW,EAAE,CAAC,CAAC;IAEpD,MAAM,aAAa,GAAyB;QAC1C;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,2BAA2B;YACpC,OAAO,EAAE,kBAAkB;YAC3B,aAAa,EAAE,OAAO,CAAC,MAAM,CAAC,CAAC,CAAC,kBAAkB,CAAC,CAAC,CAAC,IAAI;SAC1D;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,2BAA2B;YACpC,OAAO,EAAE,kBAAkB;SAC5B;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,aAAa;YACnB,OAAO,EAAE,oCAAoC;SAC9C;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,mCAAmC;YAC5C,OAAO,EAAE,gBAAgB,kBAAkB,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,WAAW,EAAE,EAAE;SAC/E;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,QAAQ;YACd,OAAO,EAAE,oBAAoB;YAC7B,OAAO,EAAE,MAAA,CAAC,MAAM,cAAc,CAAC,SAAS,CAAC,CAAC,mCAAI,EAAE;SACjD;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,SAAS;YACf,OAAO,EAAE,sBAAsB;YAC/B,OAAO,EAAE,KAAK;SACf;QACD;YACE,IAAI,EAAE,MAAM;YACZ,IAAI,EAAE,MAAM;YACZ,OAAO,EAAE,6BAA6B;SACvC;KACF,CAAC;IAEF,MAAM,OAAO,GAA2B,EAAE,CAAC;IAC3C,KAAK,MAAM,KAAK,IAAI,aAAa,EAAE;QACjC,MAAM,EAAE,IAAI,EAAE,aAAa,EAAE,GAAG,KAAK,CAAC;QACtC,OAAO,CAAC,IAAI,CAAC,GAAG,MAAA,aAAa,aAAb,aAAa,cAAb,aAAa,GAAI,OAAO,CAAC,IAAI,CAAC,mCAAI,CAAC,MAAM,IAAA,iBAAO,EAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC;KAChF;IAED,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,WAAW,EAAE,OAAO,EAAE,cAAc,EAAE,MAAM,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;IAE5F,OAAO;QACL,OAAO,EAAE;YACP,IAAI;YACJ,IAAI;YACJ,OAAO,EAAE,OAAO;YAChB,WAAW;YACX,OAAO,EAAE,cAAc;SACxB;QACD,MAAM;QACN,OAAO;QACP,IAAI;KACL,CAAC;AACJ,CAAC;AAED,MAAM,OAAO,GAAG,IAAI,mBAAO,EAAE,CAAC;AAE9B,OAAO;KACJ,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC;KACtB,OAAO,CAAC,WAAW,CAAC,OAAO,CAAC;KAC5B,WAAW,CAAC,WAAW,CAAC,WAAW,CAAC;KACpC,SAAS,CAAC,cAAc,CAAC;KACzB,MAAM,CACL,2BAA2B,EAC3B,sFAAsF,CACvF;KACA,MAAM,CAAC,0BAA0B,EAAE,4BAA4B,CAAC;KAChE,MAAM,CAAC,iCAAiC,EAAE,4BAA4B,CAAC;KACvE,MAAM,CAAC,yBAAyB,EAAE,2BAA2B,CAAC;KAC9D,MAAM,CAAC,uBAAuB,EAAE,kBAAkB,CAAC;KACnD,MAAM,CAAC,yBAAyB,EAAE,kDAAkD,CAAC;KACrF,MAAM,CAAC,uBAAuB,EAAE,4BAA4B,CAAC;KAC7D,MAAM,CAAC,eAAe,EAAE,oCAAoC,EAAE,KAAK,CAAC;KACpE,MAAM,CAAC,kBAAkB,EAAE,uCAAuC,EAAE,KAAK,CAAC;KAC1E,MAAM,CAAC,IAAI,CAAC,CAAC;AAEhB,OAAO,CAAC,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC","sourcesContent":["import spawnAsync from '@expo/spawn-async';\nimport { Command } from 'commander';\nimport downloadTarball from 'download-tarball';\nimport ejs from 'ejs';\nimport fs from 'fs-extra';\nimport path from 'path';\nimport prompts, { PromptObject } from 'prompts';\n\nconst packageJson = require('../package.json');\n\n// `yarn run` may change the current working dir, then we should use `INIT_CWD` env.\nconst CWD = process.env.INIT_CWD || process.cwd();\n\n// Ignore some paths. Especially `package.json` as it is rendered\n// from `$package.json` file instead of the original one.\nconst IGNORES_PATHS = ['.DS_Store', 'build', 'node_modules', 'package.json'];\n\n/**\n * Possible command options.\n */\ntype CommandOptions = {\n  target: string;\n  source?: string;\n  name?: string;\n  description?: string;\n  package?: string;\n  author?: string;\n  license?: string;\n  repo?: string;\n  withReadme: boolean;\n  withChangelog: boolean;\n};\n\n/**\n * Represents an object that is passed to `ejs` when rendering the template.\n */\ntype SubstitutionData = {\n  project: {\n    slug: string;\n    name: string;\n    version: string;\n    description: string;\n    package: string;\n  };\n  author: string;\n  license: string;\n  repo: string;\n};\n\ntype CustomPromptObject = PromptObject & {\n  name: string;\n  resolvedValue?: string | null;\n};\n\n/**\n * The main function of the command.\n *\n * @param target Path to the directory where to create the module. Defaults to current working dir.\n * @param command An object from `commander`.\n */\nasync function main(target: string | undefined, options: CommandOptions) {\n  const targetDir = target ? path.join(CWD, target) : CWD;\n\n  options.target = targetDir;\n  await fs.ensureDir(targetDir);\n\n  const packagePath = options.source\n    ? path.join(CWD, options.source)\n    : await downloadPackageAsync(targetDir);\n  const files = await getFilesAsync(packagePath);\n  const data = await askForSubstitutionDataAsync(targetDir, options);\n\n  // Iterate through all template files.\n  for (const file of files) {\n    const renderedRelativePath = ejs.render(file.replace(/^\\$/, ''), data, {\n      openDelimiter: '{',\n      closeDelimiter: '}',\n      escape: (value: string) => value.replace('.', path.sep),\n    });\n    const fromPath = path.join(packagePath, file);\n    const toPath = path.join(targetDir, renderedRelativePath);\n    const template = await fs.readFile(fromPath, { encoding: 'utf8' });\n    const renderedContent = ejs.render(template, data);\n\n    await fs.outputFile(toPath, renderedContent, { encoding: 'utf8' });\n  }\n\n  if (!options.source) {\n    // Files in the downloaded tarball are wrapped in `package` dir.\n    // We should remove it after all.\n    await fs.remove(packagePath);\n  }\n  if (!options.withReadme) {\n    await fs.remove(path.join(targetDir, 'README.md'));\n  }\n  if (!options.withChangelog) {\n    await fs.remove(path.join(targetDir, 'CHANGELOG.md'));\n  }\n\n  // Build TypeScript files.\n  await spawnAsync('npm', ['run', 'build'], {\n    cwd: targetDir,\n  });\n}\n\n/**\n * Recursively scans for the files within the directory. Returned paths are relative to the `root` path.\n */\nasync function getFilesAsync(root: string, dir: string | null = null): Promise<string[]> {\n  const files: string[] = [];\n  const baseDir = dir ? path.join(root, dir) : root;\n\n  for (const file of await fs.readdir(baseDir)) {\n    const relativePath = dir ? path.join(dir, file) : file;\n\n    if (IGNORES_PATHS.includes(relativePath) || IGNORES_PATHS.includes(file)) {\n      continue;\n    }\n\n    const fullPath = path.join(baseDir, file);\n    const stat = await fs.lstat(fullPath);\n\n    if (stat.isDirectory()) {\n      files.push(...(await getFilesAsync(root, relativePath)));\n    } else {\n      files.push(relativePath);\n    }\n  }\n  return files;\n}\n\n/**\n * Asks NPM registry for the url to the tarball.\n */\nasync function getNpmTarballUrl(packageName: string, version: string = 'latest'): Promise<string> {\n  const { stdout } = await spawnAsync('npm', ['view', `${packageName}@${version}`, 'dist.tarball']);\n  return stdout.trim();\n}\n\n/**\n * Gets the username of currently logged in user. Used as a default in the prompt asking for the module author.\n */\nasync function npmWhoamiAsync(targetDir: string): Promise<string | null> {\n  try {\n    const { stdout } = await spawnAsync('npm', ['whoami'], { cwd: targetDir });\n    return stdout.trim();\n  } catch (e) {\n    return null;\n  }\n}\n\n/**\n * Downloads the template from NPM registry.\n */\nasync function downloadPackageAsync(targetDir: string): Promise<string> {\n  const tarballUrl = await getNpmTarballUrl('expo-module-template');\n\n  await downloadTarball({\n    url: tarballUrl,\n    dir: targetDir,\n  });\n  return path.join(targetDir, 'package');\n}\n\n/**\n * Asks the user for some data necessary to render the template.\n * Some values may already be provided by command options, the prompt is skipped in that case.\n */\nasync function askForSubstitutionDataAsync(\n  targetDir: string,\n  options: CommandOptions\n): Promise<SubstitutionData> {\n  const defaultPackageSlug = path.basename(targetDir);\n  const defaultProjectName = defaultPackageSlug\n    .replace(/^./, (match) => match.toUpperCase())\n    .replace(/\\W+(\\w)/g, (_, p1) => p1.toUpperCase());\n\n  const promptQueries: CustomPromptObject[] = [\n    {\n      type: 'text',\n      name: 'slug',\n      message: 'What is the package slug?',\n      initial: defaultPackageSlug,\n      resolvedValue: options.target ? defaultPackageSlug : null,\n    },\n    {\n      type: 'text',\n      name: 'name',\n      message: 'What is the project name?',\n      initial: defaultProjectName,\n    },\n    {\n      type: 'text',\n      name: 'description',\n      message: 'How would you describe the module?',\n    },\n    {\n      type: 'text',\n      name: 'package',\n      message: 'What is the Android package name?',\n      initial: `expo.modules.${defaultPackageSlug.replace(/\\W/g, '').toLowerCase()}`,\n    },\n    {\n      type: 'text',\n      name: 'author',\n      message: 'Who is the author?',\n      initial: (await npmWhoamiAsync(targetDir)) ?? '',\n    },\n    {\n      type: 'text',\n      name: 'license',\n      message: 'What is the license?',\n      initial: 'MIT',\n    },\n    {\n      type: 'text',\n      name: 'repo',\n      message: 'What is the repository URL?',\n    },\n  ];\n\n  const answers: Record<string, string> = {};\n  for (const query of promptQueries) {\n    const { name, resolvedValue } = query;\n    answers[name] = resolvedValue ?? options[name] ?? (await prompts(query))[name];\n  }\n\n  const { slug, name, description, package: projectPackage, author, license, repo } = answers;\n\n  return {\n    project: {\n      slug,\n      name,\n      version: '0.1.0',\n      description,\n      package: projectPackage,\n    },\n    author,\n    license,\n    repo,\n  };\n}\n\nconst program = new Command();\n\nprogram\n  .name(packageJson.name)\n  .version(packageJson.version)\n  .description(packageJson.description)\n  .arguments('[target_dir]')\n  .option(\n    '-s, --source <source_dir>',\n    'Local path to the template. By default it downloads `expo-module-template` from NPM.'\n  )\n  .option('-n, --name <module_name>', 'Name of the native module.')\n  .option('-d, --description <description>', 'Description of the module.')\n  .option('-p, --package <package>', 'The Android package name.')\n  .option('-a, --author <author>', 'The author name.')\n  .option('-l, --license <license>', 'The license that the module is distributed with.')\n  .option('-r, --repo <repo_url>', 'The URL to the repository.')\n  .option('--with-readme', 'Whether to include README.md file.', false)\n  .option('--with-changelog', 'Whether to include CHANGELOG.md file.', false)\n  .action(main);\n\nprogram.parse(process.argv);\n"]}

package/package.json

@@ -1,11 +1,49 @@
 {
   "name": "create-expo-module",
-  "version": "0.0.0",
-  "description": "",
-  "main": "index.js",
+  "version": "0.1.0",
+  "description": "The script to create the Expo module",
+  "main": "build/create-expo-module.js",
+  "types": "build/create-expo-module.d.ts",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "build": "expo-module build",
+    "clean": "expo-module clean",
+    "lint": "expo-module lint",
+    "expo-module": "expo-module"
   },
-  "author": "",
-  "license": "MIT"
+  "bin": {
+    "create-expo-module": "./bin/create-expo-module"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/expo/expo.git",
+    "directory": "packages/create-expo-module"
+  },
+  "keywords": [
+    "expo",
+    "module",
+    "modules",
+    "library",
+    "react",
+    "native"
+  ],
+  "author": "Expo",
+  "license": "MIT",
+  "bugs": {
+    "url": "https://github.com/expo/expo/issues"
+  },
+  "homepage": "https://github.com/expo/expo/tree/master/packages/expo",
+  "dependencies": {
+    "@expo/spawn-async": "^1.5.0",
+    "commander": "^8.3.0",
+    "download-tarball": "^2.0.0",
+    "ejs": "^3.1.6",
+    "fs-extra": "^10.0.0",
+    "prompts": "^2.4.2"
+  },
+  "devDependencies": {
+    "@types/ejs": "^3.1.0",
+    "@types/prompts": "^2.0.14",
+    "expo-module-scripts": "^2.0.0"
+  },
+  "gitHead": "c87080dbe1d7cefd66a9f959c090ff1a2d2ab26d"
 }

package/src/create-expo-module.ts

@@ -0,0 +1,265 @@
+import spawnAsync from '@expo/spawn-async';
+import { Command } from 'commander';
+import downloadTarball from 'download-tarball';
+import ejs from 'ejs';
+import fs from 'fs-extra';
+import path from 'path';
+import prompts, { PromptObject } from 'prompts';
+
+const packageJson = require('../package.json');
+
+// `yarn run` may change the current working dir, then we should use `INIT_CWD` env.
+const CWD = process.env.INIT_CWD || process.cwd();
+
+// Ignore some paths. Especially `package.json` as it is rendered
+// from `$package.json` file instead of the original one.
+const IGNORES_PATHS = ['.DS_Store', 'build', 'node_modules', 'package.json'];
+
+/**
+ * Possible command options.
+ */
+type CommandOptions = {
+  target: string;
+  source?: string;
+  name?: string;
+  description?: string;
+  package?: string;
+  author?: string;
+  license?: string;
+  repo?: string;
+  withReadme: boolean;
+  withChangelog: boolean;
+};
+
+/**
+ * Represents an object that is passed to `ejs` when rendering the template.
+ */
+type SubstitutionData = {
+  project: {
+    slug: string;
+    name: string;
+    version: string;
+    description: string;
+    package: string;
+  };
+  author: string;
+  license: string;
+  repo: string;
+};
+
+type CustomPromptObject = PromptObject & {
+  name: string;
+  resolvedValue?: string | null;
+};
+
+/**
+ * The main function of the command.
+ *
+ * @param target Path to the directory where to create the module. Defaults to current working dir.
+ * @param command An object from `commander`.
+ */
+async function main(target: string | undefined, options: CommandOptions) {
+  const targetDir = target ? path.join(CWD, target) : CWD;
+
+  options.target = targetDir;
+  await fs.ensureDir(targetDir);
+
+  const packagePath = options.source
+    ? path.join(CWD, options.source)
+    : await downloadPackageAsync(targetDir);
+  const files = await getFilesAsync(packagePath);
+  const data = await askForSubstitutionDataAsync(targetDir, options);
+
+  // Iterate through all template files.
+  for (const file of files) {
+    const renderedRelativePath = ejs.render(file.replace(/^\$/, ''), data, {
+      openDelimiter: '{',
+      closeDelimiter: '}',
+      escape: (value: string) => value.replace('.', path.sep),
+    });
+    const fromPath = path.join(packagePath, file);
+    const toPath = path.join(targetDir, renderedRelativePath);
+    const template = await fs.readFile(fromPath, { encoding: 'utf8' });
+    const renderedContent = ejs.render(template, data);
+
+    await fs.outputFile(toPath, renderedContent, { encoding: 'utf8' });
+  }
+
+  if (!options.source) {
+    // Files in the downloaded tarball are wrapped in `package` dir.
+    // We should remove it after all.
+    await fs.remove(packagePath);
+  }
+  if (!options.withReadme) {
+    await fs.remove(path.join(targetDir, 'README.md'));
+  }
+  if (!options.withChangelog) {
+    await fs.remove(path.join(targetDir, 'CHANGELOG.md'));
+  }
+
+  // Build TypeScript files.
+  await spawnAsync('npm', ['run', 'build'], {
+    cwd: targetDir,
+  });
+}
+
+/**
+ * Recursively scans for the files within the directory. Returned paths are relative to the `root` path.
+ */
+async function getFilesAsync(root: string, dir: string | null = null): Promise<string[]> {
+  const files: string[] = [];
+  const baseDir = dir ? path.join(root, dir) : root;
+
+  for (const file of await fs.readdir(baseDir)) {
+    const relativePath = dir ? path.join(dir, file) : file;
+
+    if (IGNORES_PATHS.includes(relativePath) || IGNORES_PATHS.includes(file)) {
+      continue;
+    }
+
+    const fullPath = path.join(baseDir, file);
+    const stat = await fs.lstat(fullPath);
+
+    if (stat.isDirectory()) {
+      files.push(...(await getFilesAsync(root, relativePath)));
+    } else {
+      files.push(relativePath);
+    }
+  }
+  return files;
+}
+
+/**
+ * Asks NPM registry for the url to the tarball.
+ */
+async function getNpmTarballUrl(packageName: string, version: string = 'latest'): Promise<string> {
+  const { stdout } = await spawnAsync('npm', ['view', `${packageName}@${version}`, 'dist.tarball']);
+  return stdout.trim();
+}
+
+/**
+ * Gets the username of currently logged in user. Used as a default in the prompt asking for the module author.
+ */
+async function npmWhoamiAsync(targetDir: string): Promise<string | null> {
+  try {
+    const { stdout } = await spawnAsync('npm', ['whoami'], { cwd: targetDir });
+    return stdout.trim();
+  } catch (e) {
+    return null;
+  }
+}
+
+/**
+ * Downloads the template from NPM registry.
+ */
+async function downloadPackageAsync(targetDir: string): Promise<string> {
+  const tarballUrl = await getNpmTarballUrl('expo-module-template');
+
+  await downloadTarball({
+    url: tarballUrl,
+    dir: targetDir,
+  });
+  return path.join(targetDir, 'package');
+}
+
+/**
+ * Asks the user for some data necessary to render the template.
+ * Some values may already be provided by command options, the prompt is skipped in that case.
+ */
+async function askForSubstitutionDataAsync(
+  targetDir: string,
+  options: CommandOptions
+): Promise<SubstitutionData> {
+  const defaultPackageSlug = path.basename(targetDir);
+  const defaultProjectName = defaultPackageSlug
+    .replace(/^./, (match) => match.toUpperCase())
+    .replace(/\W+(\w)/g, (_, p1) => p1.toUpperCase());
+
+  const promptQueries: CustomPromptObject[] = [
+    {
+      type: 'text',
+      name: 'slug',
+      message: 'What is the package slug?',
+      initial: defaultPackageSlug,
+      resolvedValue: options.target ? defaultPackageSlug : null,
+    },
+    {
+      type: 'text',
+      name: 'name',
+      message: 'What is the project name?',
+      initial: defaultProjectName,
+    },
+    {
+      type: 'text',
+      name: 'description',
+      message: 'How would you describe the module?',
+    },
+    {
+      type: 'text',
+      name: 'package',
+      message: 'What is the Android package name?',
+      initial: `expo.modules.${defaultPackageSlug.replace(/\W/g, '').toLowerCase()}`,
+    },
+    {
+      type: 'text',
+      name: 'author',
+      message: 'Who is the author?',
+      initial: (await npmWhoamiAsync(targetDir)) ?? '',
+    },
+    {
+      type: 'text',
+      name: 'license',
+      message: 'What is the license?',
+      initial: 'MIT',
+    },
+    {
+      type: 'text',
+      name: 'repo',
+      message: 'What is the repository URL?',
+    },
+  ];
+
+  const answers: Record<string, string> = {};
+  for (const query of promptQueries) {
+    const { name, resolvedValue } = query;
+    answers[name] = resolvedValue ?? options[name] ?? (await prompts(query))[name];
+  }
+
+  const { slug, name, description, package: projectPackage, author, license, repo } = answers;
+
+  return {
+    project: {
+      slug,
+      name,
+      version: '0.1.0',
+      description,
+      package: projectPackage,
+    },
+    author,
+    license,
+    repo,
+  };
+}
+
+const program = new Command();
+
+program
+  .name(packageJson.name)
+  .version(packageJson.version)
+  .description(packageJson.description)
+  .arguments('[target_dir]')
+  .option(
+    '-s, --source <source_dir>',
+    'Local path to the template. By default it downloads `expo-module-template` from NPM.'
+  )
+  .option('-n, --name <module_name>', 'Name of the native module.')
+  .option('-d, --description <description>', 'Description of the module.')
+  .option('-p, --package <package>', 'The Android package name.')
+  .option('-a, --author <author>', 'The author name.')
+  .option('-l, --license <license>', 'The license that the module is distributed with.')
+  .option('-r, --repo <repo_url>', 'The URL to the repository.')
+  .option('--with-readme', 'Whether to include README.md file.', false)
+  .option('--with-changelog', 'Whether to include CHANGELOG.md file.', false)
+  .action(main);
+
+program.parse(process.argv);

package/tsconfig.json

@@ -0,0 +1,23 @@
+{
+  "extends": "@tsconfig/node12/tsconfig.json",
+  "include": ["./src"],
+  "exclude": ["**/__mocks__/*", "**/__tests__/*"],
+  "compilerOptions": {
+    "outDir": "./build",
+    "module": "commonjs",
+    "moduleResolution": "node",
+    "types": [],
+    "typeRoots": ["./ts-declarations", "node_modules/@types"],
+    "sourceMap": true,
+    "declaration": true,
+    "inlineSources": true,
+    "strictNullChecks": true,
+    "strictPropertyInitialization": true,
+    "strictFunctionTypes": true,
+    "skipLibCheck": true,
+    "noImplicitAny": false,
+    "noImplicitThis": true,
+    "noImplicitReturns": true,
+    "allowSyntheticDefaultImports": true
+  }
+}