Merge pull request #17 from livestorm/liv-5386-review-command

feat: improving the way we deal with metadata, liv-5386

Author: Michaelvilleneuve

src/cmds/create.js

@@ -4,6 +4,8 @@ const prompts = require('prompts')
 const path = require('path')
 const rimraf = require('rimraf')
 
+const defaultMetadata = require('../helpers/defaultMetadata')
+
 const questions = [
   {
     type: 'text',
@@ -63,6 +65,7 @@ module.exports = () => {
       const environments = require(`${pathForPlugin(answers.name)}/environments.json`)
       environments.development.name = answers.name
       environments.development.apiToken = answers.apiToken || ''
+      environments.development.metadata = defaultMetadata(answers)
       fs.writeFileSync(
         `./livestorm-plugin-${answers.name}/environments.json`,
         JSON.stringify(environments, null, 2)
@@ -71,7 +74,7 @@ module.exports = () => {
       execSync(`cd ${pathForPlugin(answers.name)} && git init && git add --a && git commit -m "First commit"`)
 
       console.log('All done 🙌')
-      console.log(`If you need to change any of the pre-given answers feel free to edit ./${directoryNameFor(answers.name)}/package.json`)
+      console.log(`If you need to change any of the pre-given answers feel free to edit ./${directoryNameFor(answers.name)}/environments.json`)
       console.log(`You can start coding by opening ./${directoryNameFor(answers.name)}/index.ts`)
       console.log(`Visit https://github.com/livestorm/livestorm-plugin for documentation`)
     } catch(err) {

src/cmds/review.js

@@ -9,6 +9,7 @@ const { execSync } = require('child_process')
 const uploadFileOrDirectory = require('../helpers/uploadFileOrDirectory')
 const getLivestormPluginInformation = require('../helpers/getLivestormPluginInformation')
 const livestormDomain = require('../helpers/livestormDomain')
+const validateMetadata = require('../helpers/validateMetadata')
 
 const questions = [
   {
@@ -76,6 +77,7 @@ module.exports = async function review() {
       console.log('Syncing plugin code...')
       execSync('livestorm publish production')
       answers.metadata = config.metadata
+      validateMetadata(config.metadata)
     }
 
     const zipUrl = await uploadZip(createZip())

src/helpers/defaultMetadata.js

@@ -0,0 +1,14 @@
+
+module.exports = function defaultMetadata(answers) {
+  return {
+    logo: "https://uploads-ssl.webflow.com/60ad0f9314e628baa6971a76/60ec0b72f45280483f7957cf_Icon-Livestorm-Primary.svg",
+    translations: {
+      title: {
+        en: answers.name.charAt(0).toUpperCase() + answers.name.slice(1)
+      },
+      description: {
+       en: "This is your plugin description, you can change it by editing the metadata of your plugin's environment."
+      }
+    }
+  }
+}

src/helpers/validateMetadata.js

@@ -0,0 +1,20 @@
+
+function validateMetadata(json) {
+  try {
+    if (!json) throw 'Your environment is missing the "metadata" property.'
+    if (!json.logo) throw 'No logo provided in the "metadata" property.'
+
+    if (!json.translations) throw 'Your "metadata" must include a translations object to display your plugin in the marketplace.'
+    if (!json.translations.title) throw 'You must provide a title in the translations object.'
+    if (!json.translations.title.en) throw 'Your title does not contain english translations.'
+
+    if (!json.translations.description) throw 'You must provide a translated description in the translations object.'
+    if (!json.translations.description.en) throw 'Your description does not contain english translations.'
+  } catch(err) {
+    console.log(err)
+    console.log('Make sure your environment\'s "metadata" property follows the correct pattern: https://developers.livestorm.co/docs/review-marketplace#submit-your-plugin-to-the-marketplace')
+    process.exit(1)
+  }
+}
+
+module.exports = validateMetadata