add export-template command to cli #10331

markkaylor · 2021-05-17T15:02:52Z

What does it do?

Adds a command to the CLI to export the current Strapi project as a Strapi template

Why is it needed?

Currently when creating/updating a template you have to copy all the files and folders over manually from a development directory to a template directory.

How to test it?

Create a strapi project, yarn link strapi, yarn strapi export-template test

codecov · 2021-05-17T15:09:16Z

Codecov Report

Merging #10331 (c318c3d) into master (5207606) will increase coverage by 0.22%.
The diff coverage is 94.87%.

@@            Coverage Diff             @@
##           master   #10331      +/-   ##
==========================================
+ Coverage   57.84%   58.06%   +0.22%     
==========================================
  Files         184      185       +1     
  Lines        6395     6434      +39     
  Branches     1394     1399       +5     
==========================================
+ Hits         3699     3736      +37     
- Misses       2233     2235       +2     
  Partials      463      463

Flag	Coverage Δ
front	`∅ <ø> (∅)`
unit	`58.06% <94.87%> (+0.22%)`	⬆️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/strapi/lib/commands/generate-template.js	`94.87% <94.87%> (ø)`

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5207606...c318c3d. Read the comment docs.

alexandrebodin

Shoud we also create an empty template.json file for an example ?

Last but not least, you will have to add some tests to your command code :)

alexandrebodin · 2021-05-17T16:00:35Z

packages/strapi/bin/strapi.js

@@ -230,4 +230,11 @@ program
  .option('-p, --password <password>', 'New password for the user')
  .action(getLocalScript('admin-reset'));

+// `$ strapi export-template <name>`
+program
+  .command('export-template')


We should keep some naming convention here: {kind}:{action}

alexandrebodin · 2021-05-17T16:02:31Z

packages/strapi/bin/strapi.js

+// `$ strapi export-template <name>`
+program
+  .command('export-template')
+  .arguments('<name>')


you can put that directly in command('command <directory>')

alexandrebodin · 2021-05-17T16:05:42Z

packages/strapi/lib/commands/exportTemplate.js

+const inquirer = require('inquirer');
+
+// All directories that a template could need
+const DIRECTORIES = ['api', 'components', 'config', 'data'];


Why do we need to copy the config ? this could favor some config leaking by mistakes if this isn't required I would avoid it

The only reason is to copy the config/functions/bootstrap.js to get the seed script. I could target the config/functions directory instead or the bootstrap.js file directly.

I see the point but a user that would be using this command would most likely not have a seed script. The looks like a command that is only needed in the expansion squad :) I think this should be in another cli actually :)

Ok yeah I see what you are saying. Originally I was thinking as an internal tool, but I do think it would be great to expose this to the community so we can encourage them to make templates/starters. cc @remidej @malgamves

love the idea!! This would be very useful for a lot of people should it be an option in the CLI!! Plus not to mention it would take the friction out of creating templates/starters. Def for opening it up to everyone

alexandrebodin · 2021-05-17T16:07:41Z

packages/strapi/lib/commands/exportTemplate.js

+
+module.exports = async function exportTemplate(name) {
+  // Create the template directory
+  const templatePath = resolve(`../strapi-template-${name}`);


I think this should just use the parameter as a directory directly with a ../ or a prefix so you can select the folder you want the template to go to.

packages/strapi/bin/strapi.js

alexandrebodin

Looks pretty much ready

Can you add js doc to the functions in the command
I'm not sure about the function name I would expect createTemplate to also copy the content :)

packages/strapi/lib/commands/generate-template.js

alexandrebodin · 2021-05-31T09:47:36Z

packages/strapi/lib/commands/generate-template.js

+module.exports = async function generateTemplate(directory) {
+  // Allow any relative path,
+  // otherwise default destination is at the same level as the current directory
+  const dir = directory.startsWith('.') ? directory : `../${directory}`;


I'm not sure this is necessary to create a folder outisde of the project by default 🤔 if the cli is well documented then the user will know the directory is the path the template will be saved to so they should decide on their own don't you think ?

Yeah I see what you mean. I think since I originally defined the experience as providing the name and defaulting to a path, I was sort of stuck on that idea. But it definitely makes more sense to just let the user have full control. I'll update.

alexandrebodin · 2021-05-31T12:47:25Z

packages/strapi/lib/commands/generate-template.js

+async function copyContent(templatePath, rootBase) {
+  for (const item of TEMPLATE_CONTENT) {
+    try {
+      await fse.copy(join(process.cwd(), item), join(templatePath, item));


You should check it exists before copying as if it doesn't we shouldn't display an error and continue :)

packages/strapi/lib/commands/generate-template.js

markkaylor self-assigned this May 17, 2021

markkaylor requested a review from remidej May 17, 2021 15:03

markkaylor force-pushed the feat/export-template branch from e5b499c to 0d4b4a4 Compare May 17, 2021 15:08

markkaylor requested a review from alexandrebodin May 17, 2021 15:09

markkaylor force-pushed the feat/export-template branch from 0d4b4a4 to 074e5b7 Compare May 17, 2021 15:19

alexandrebodin requested changes May 17, 2021

View reviewed changes

markkaylor force-pushed the feat/export-template branch from 074e5b7 to 196ced5 Compare May 24, 2021 15:12

markkaylor requested a review from alexandrebodin May 25, 2021 06:51

alexandrebodin reviewed May 25, 2021

View reviewed changes

packages/strapi/bin/strapi.js Outdated Show resolved Hide resolved

markkaylor force-pushed the feat/export-template branch from 196ced5 to c7281e7 Compare May 26, 2021 08:28

alexandrebodin requested changes May 26, 2021

View reviewed changes

packages/strapi/lib/commands/generate-template.js Outdated Show resolved Hide resolved

markkaylor requested a review from alexandrebodin May 26, 2021 10:55

markkaylor force-pushed the feat/export-template branch 2 times, most recently from 05d9cd8 to 4e859c1 Compare May 26, 2021 12:40

alexandrebodin reviewed May 31, 2021

View reviewed changes

markkaylor added 8 commits May 31, 2021 13:43

add export-template command to cli

8beb4b8

add tests

e652a53

rename export => generate

c2d438b

add template config file to root

a6eb49b

refactor

e71d573

update test variables

c25e212

change wording

5bfbf33

remove default path

aad0515

markkaylor force-pushed the feat/export-template branch from 4e859c1 to aad0515 Compare May 31, 2021 11:44

markkaylor requested a review from alexandrebodin May 31, 2021 11:48

alexandrebodin reviewed May 31, 2021

View reviewed changes

copy folders that exist

eec4aa2

markkaylor requested a review from alexandrebodin May 31, 2021 14:36

alexandrebodin reviewed May 31, 2021

View reviewed changes

packages/strapi/lib/commands/generate-template.js Outdated Show resolved Hide resolved

exit loop if path doesn't exist

c318c3d

markkaylor requested a review from alexandrebodin May 31, 2021 15:57

alexandrebodin approved these changes May 31, 2021

View reviewed changes

alexandrebodin added this to the 3.6.3 milestone May 31, 2021

alexandrebodin added source: cli Source is cli package issue: enhancement Issue suggesting an enhancement to an existing feature labels May 31, 2021

markkaylor merged commit 85eecf7 into master May 31, 2021

markkaylor deleted the feat/export-template branch May 31, 2021 16:22

markkaylor mentioned this pull request Jun 2, 2021

add strapi:generate template command strapi/documentation#308

Merged

This was referenced Jun 13, 2021

fix(deps): update all dependencies (patch) SocialGouv/1000jours#301

Merged

Update strapi monorepo to v3.6.10 Tejaswgupta/furniture-shop-strapi#21

Open

renovate bot mentioned this pull request Jun 20, 2021

fix(deps): update all dependencies (patch) SocialGouv/1000jours#352

Merged

1 task

renovate bot mentioned this pull request Jul 30, 2021

Update strapi monorepo to v3.6.7 spences10/strapi-starter-nextjs-blog#34

Merged

1 task

renovate bot mentioned this pull request Aug 11, 2021

Update strapi monorepo to v3.6.7 spences10/dope-devs-backend#7

Merged

1 task

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

add export-template command to cli #10331

add export-template command to cli #10331

markkaylor commented May 17, 2021

codecov bot commented May 17, 2021 •

edited

alexandrebodin left a comment

alexandrebodin May 17, 2021

alexandrebodin May 17, 2021

alexandrebodin May 17, 2021

markkaylor May 18, 2021

alexandrebodin May 18, 2021

markkaylor May 18, 2021

malgamves May 18, 2021

alexandrebodin May 17, 2021

alexandrebodin left a comment

alexandrebodin May 31, 2021

markkaylor May 31, 2021

alexandrebodin May 31, 2021

add export-template command to cli #10331

add export-template command to cli #10331

Conversation

markkaylor commented May 17, 2021

What does it do?

Why is it needed?

How to test it?

codecov bot commented May 17, 2021 • edited

Codecov Report

alexandrebodin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

alexandrebodin left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

codecov bot commented May 17, 2021 •

edited