feat(template): add widget template (#455)

* feat(template): add widget template

this changes the questions asked into two categories, and asks one extra question for the integration type.

Alternatively for the questions, the template question could come first, and then the category could be implied

* make tests pass

* update tests

* avoid undefined if from prompted

* Apply suggestions from code review

Co-authored-by: François Chalifour <[email protected]>

* readme feedback

* update test

* update inquirer

* use library version

* fix typos

* chore: remove limitation

* add versioning

* update tests

* use && in build script

* fix nits

Co-authored-by: François Chalifour <[email protected]>

Author: Haroenv

e2e/__snapshots__/templates.test.js.snap

@@ -37,7 +37,7 @@ describe('Templates', () => {
           name: templateConfig.appName,
           template: templateName,
           // We fetch the earliest supported version in order to not change
-          // the test output everytime we release a new version of a library.
+          // the test output every time we release a new version of a library.
           libraryVersion: await getEarliestLibraryVersion({
             libraryName: templateConfig.libraryName,
             supportedVersion: templateConfig.supportedVersion,
@@ -48,6 +48,7 @@ describe('Templates', () => {
           searchPlaceholder: 'Search placeholder',
           attributesToDisplay: ['attribute1', 'attribute2'],
           attributesForFaceting: ['facet1', 'facet2'],
+          organization: 'algolia',
         };
 
         configFilePath = `${temporaryDirectory}/${templateConfig.appName}.config.json`;

e2e/templates.test.js

@@ -39,7 +39,7 @@
     "algoliasearch": "3.35.1",
     "chalk": "3.0.0",
     "commander": "4.0.1",
-    "inquirer": "7.0.1",
+    "inquirer": "8.0.0",
     "jstransformer-handlebars": "1.1.0",
     "latest-semver": "2.0.0",
     "load-json-file": "6.2.0",

package.json

@@ -6,10 +6,10 @@ exports[`Options with invalid name throws 1`] = `
   - name can only contain URL-friendly characters"
 `;
 
-exports[`Options with unknown template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options with unknown template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
 
-exports[`Options with wrong template path throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options with wrong template path throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
 
 exports[`Options without path throws 1`] = `"The option \`path\` is required."`;
 
-exports[`Options without template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;
+exports[`Options without template throws 1`] = `"The template directory must contain a configuration file \`.template.js\` or must be one of those: Angular InstantSearch, Autocomplete.js, InstantSearch Android, InstantSearch iOS, InstantSearch.js, InstantSearch.js 2, InstantSearch.js widget, JavaScript Client, JavaScript Helper, JavaScript Helper 2, React InstantSearch, React InstantSearch Native, Vue InstantSearch, Vue InstantSearch 1, Vue InstantSearch 2"`;

src/api/__tests__/__snapshots__/index.test.js.snap

@@ -1,7 +1,6 @@
-const path = require('path');
 const loadJsonFile = require('load-json-file');
 const utils = require('../../utils');
-const getConfiguration = require('../getConfiguration');
+const { getConfiguration, getLibraryVersion } = require('../getConfiguration');
 
 jest.mock('load-json-file');
 
@@ -18,18 +17,6 @@ test('without template throws', async () => {
   );
 });
 
-test('with template transforms to its relative path', async () => {
-  const configuration = await getConfiguration({
-    answers: { template: 'InstantSearch.js' },
-  });
-
-  expect(configuration).toEqual(
-    expect.objectContaining({
-      template: path.resolve('src/templates/InstantSearch.js'),
-    })
-  );
-});
-
 test('with options from arguments and prompt merge', async () => {
   const configuration = await getConfiguration({
     options: {
@@ -54,13 +41,14 @@ test('without stable version available', async () => {
     Promise.resolve(['1.0.0-beta.0'])
   );
 
-  const configuration = await getConfiguration({
-    answers: {
+  const libraryVersion = await getLibraryVersion(
+    {
       template: 'InstantSearch.js',
     },
-  });
+    utils.getAppTemplateConfig(utils.getTemplatePath('InstantSearch.js'))
+  );
 
-  expect(configuration.libraryVersion).toBe('1.0.0-beta.0');
+  expect(libraryVersion).toBe('1.0.0-beta.0');
 });
 
 test('with config file overrides all options', async () => {

src/cli/__tests__/getConfiguration.test.js

@@ -1,16 +1,38 @@
 const latestSemver = require('latest-semver');
 const loadJsonFile = require('load-json-file');
+const camelCase = require('lodash.camelcase');
 
-const {
-  getAppTemplateConfig,
-  fetchLibraryVersions,
-  getTemplatePath,
-} = require('../utils');
+const { fetchLibraryVersions } = require('../utils');
 
-module.exports = async function getConfiguration({
-  options = {},
-  answers = {},
-} = {}) {
+function capitalize(str) {
+  return str.substr(0, 1).toUpperCase() + str.substr(1);
+}
+
+function createNameAlternatives({ organization, name }) {
+  return {
+    packageName: `@${organization}/${name}`,
+    widgetType: `${organization}.${name}`,
+    camelCaseName: camelCase(name),
+    pascalCaseName: capitalize(camelCase(name)),
+  };
+}
+
+async function getLibraryVersion(config, templateConfig) {
+  const { libraryName } = templateConfig;
+  const { libraryVersion } = config;
+
+  if (libraryName && !libraryVersion) {
+    const versions = await fetchLibraryVersions(libraryName);
+
+    // Return the latest available version when
+    // the stable version is not available
+    return latestSemver(versions) || versions[0];
+  }
+
+  return libraryVersion;
+}
+
+async function getConfiguration({ options = {}, answers = {} } = {}) {
   const config = options.config
     ? await loadJsonFile(options.config) // From configuration file given as an argument
     : { ...options, ...answers }; // From the arguments and the prompt
@@ -19,24 +41,11 @@ module.exports = async function getConfiguration({
     throw new Error('The template is required in the config.');
   }
 
-  const templatePath = getTemplatePath(config.template);
-  const templateConfig = getAppTemplateConfig(templatePath);
-  let { libraryVersion } = config;
-
-  if (templateConfig.libraryName && !libraryVersion) {
-    libraryVersion = await fetchLibraryVersions(
-      templateConfig.libraryName
-    ).then(
-      versions =>
-        // Return the lastest available version when
-        // the stable version is not available
-        latestSemver(versions) || versions[0]
-    );
-  }
+  return config;
+}
 
-  return {
-    ...config,
-    libraryVersion,
-    template: templatePath,
-  };
+module.exports = {
+  getConfiguration,
+  getLibraryVersion,
+  createNameAlternatives,
 };