create-expo-module 0.3.0 → 0.4.1

package/src/prompts.ts

@@ -0,0 +1,80 @@
+import path from 'path';
+import { Answers, PromptObject } from 'prompts';
+import validateNpmPackage from 'validate-npm-package-name';
+
+import { findGitHubEmail, findGitHubProfileUrl, findMyName, guessRepoUrl } from './utils';
+
+export default async function getPrompts(targetDir: string): Promise<PromptObject<string>[]> {
+  const targetBasename = path.basename(targetDir);
+
+  return [
+    {
+      type: 'text',
+      name: 'slug',
+      message: 'What is the name of the npm package?',
+      initial: validateNpmPackage(targetBasename).validForNewPackages ? targetBasename : undefined,
+      validate: (input) =>
+        validateNpmPackage(input).validForNewPackages || 'Must be a valid npm package name',
+    },
+    {
+      type: 'text',
+      name: 'name',
+      message: 'What is the native module name?',
+      initial: (_, answers: Answers<string>) => {
+        return answers.slug
+          .replace(/^@/, '')
+          .replace(/^./, (match) => match.toUpperCase())
+          .replace(/\W+(\w)/g, (_, p1) => p1.toUpperCase());
+      },
+      validate: (input) => !!input || 'The native module name cannot be empty',
+    },
+    {
+      type: 'text',
+      name: 'description',
+      message: 'How would you describe the module?',
+      initial: 'My new module',
+      validate: (input) => !!input || 'The description cannot be empty',
+    },
+    {
+      type: 'text',
+      name: 'package',
+      message: 'What is the Android package name?',
+      initial: (_, answers: Answers<string>) => {
+        const namespace = answers.slug
+          .replace(/\W/g, '')
+          .replace(/^(expo|reactnative)/, '')
+          .toLowerCase();
+        return `expo.modules.${namespace}`;
+      },
+      validate: (input) => !!input || 'The Android package name cannot be empty',
+    },
+    {
+      type: 'text',
+      name: 'authorName',
+      message: 'What is the name of the package author?',
+      initial: await findMyName(),
+      validate: (input) => !!input || 'Cannot be empty',
+    },
+    {
+      type: 'text',
+      name: 'authorEmail',
+      message: 'What is the email address of the author?',
+      initial: await findGitHubEmail(),
+    },
+    {
+      type: 'text',
+      name: 'authorUrl',
+      message: "What is the URL to the author's GitHub profile?",
+      initial: async (_, answers: Answers<string>) =>
+        await findGitHubProfileUrl(answers.authorEmail),
+    },
+    {
+      type: 'text',
+      name: 'repo',
+      message: 'What is the URL for the repository?',
+      initial: async (_, answers: Answers<string>) =>
+        await guessRepoUrl(answers.authorUrl, answers.slug),
+      validate: (input) => /^https?:\/\//.test(input) || 'Must be a valid URL',
+    },
+  ];
+}

package/src/types.ts

@@ -0,0 +1,35 @@
+import { PromptObject } from 'prompts';
+
+/**
+ * Possible command options.
+ */
+export type CommandOptions = {
+  target: string;
+  source?: string;
+  withReadme: boolean;
+  withChangelog: boolean;
+  example: boolean;
+};
+
+/**
+ * Represents an object that is passed to `ejs` when rendering the template.
+ */
+export type SubstitutionData = {
+  project: {
+    slug: string;
+    name: string;
+    version: string;
+    description: string;
+    package: string;
+  };
+  author: string;
+  license: string;
+  repo: string;
+};
+
+export type CustomPromptObject = PromptObject & {
+  name: string;
+  resolvedValue?: string | null;
+};
+
+export type Answers = Record<string, string>;

package/src/utils.ts

@@ -0,0 +1,75 @@
+import chalk from 'chalk';
+import spawn from 'cross-spawn';
+import githubUsername from 'github-username';
+import ora from 'ora';
+
+export type StepOptions = ora.Options;
+
+export async function newStep<Result>(
+  title: string,
+  action: (step: ora.Ora) => Promise<Result> | Result,
+  options: StepOptions = {}
+): Promise<Result> {
+  const disabled = process.env.CI || process.env.EXPO_DEBUG;
+  const step = ora({
+    text: chalk.bold(title),
+    isEnabled: !disabled,
+    stream: disabled ? process.stdout : process.stderr,
+    ...options,
+  });
+
+  step.start();
+
+  try {
+    return await action(step);
+  } catch (error) {
+    step.fail();
+    console.error(error);
+    process.exit(1);
+  }
+}
+
+/**
+ * Finds user's name by reading it from the git config.
+ */
+export async function findMyName(): Promise<string> {
+  try {
+    return spawn.sync('git', ['config', '--get', 'user.name']).stdout.toString().trim();
+  } catch {
+    return '';
+  }
+}
+
+/**
+ * Finds user's email by reading it from the git config.
+ */
+export async function findGitHubEmail(): Promise<string> {
+  try {
+    return spawn.sync('git', ['config', '--get', 'user.email']).stdout.toString().trim();
+  } catch {
+    return '';
+  }
+}
+
+/**
+ * Get the GitHub username from an email address if the email can be found in any commits on GitHub.
+ */
+export async function findGitHubProfileUrl(email: string): Promise<string> {
+  try {
+    const username = (await githubUsername(email)) ?? '';
+    return `https://github.com/${username}`;
+  } catch {
+    return '';
+  }
+}
+
+/**
+ * Guesses the repository URL based on the author profile URL and the package slug.
+ */
+export async function guessRepoUrl(authorUrl: string, slug: string) {
+  if (/^https?:\/\/github.com\/[^/]+/.test(authorUrl)) {
+    const normalizedSlug = slug.replace(/^@/, '').replace(/\//g, '-');
+    return `${authorUrl}/${normalizedSlug}`;
+  }
+  return '';
+}