@flarum/cli 1.0.0 → 2.0.0-beta.12

package/README.md

@@ -37,7 +37,7 @@ $ npm install -g @flarum/cli
 $ flarum-cli COMMAND
 running command...
 $ flarum-cli (-v|--version|version)
-@flarum/cli/1.0.0 linux-x64 node-v14.17.2
+@flarum/cli/2.0.0-beta.12 linux-x64 node-v16.13.0
 $ flarum-cli --help [COMMAND]
 USAGE
   $ flarum-cli COMMAND
@@ -192,7 +192,7 @@ For example:
         },
       ]);
   })
-  .run(stubPathProviderFactory(), paramProviderFactory, stubPhpProviderFactory());
+  .run(new Paths({...}), new PromptsIO(), {php: new PhpProvider(...)});
 ```
 
 

package/bin/run

@@ -1,5 +1,7 @@
 #!/usr/bin/env node
 
-require('@oclif/command').run()
-.then(require('@oclif/command/flush'))
-.catch(require('@oclif/errors/handle'))
+require('module-alias').addAlias('boilersmith', `${__dirname}/../lib/boilersmith`);
+
+const oclif = require('@oclif/core');
+
+oclif.run().then(require('@oclif/core/flush')).catch(require('@oclif/core/handle'));

package/boilerplate/skeleton/extension/.gitattributes

@@ -1,4 +1,18 @@
-js/src export-ignore
-.git* export-ignore
+.gitattributes export-ignore
+.gitignore export-ignore
+.gitmodules export-ignore
+.github export-ignore
+.travis export-ignore
+.travis.yml export-ignore
+.editorconfig export-ignore
+.styleci.yml export-ignore
 
-js/dist/*.js -diff
+phpunit.xml export-ignore
+tests export-ignore
+
+js/dist/* -diff
+js/dist/* linguist-generated
+js/dist-typings/* linguist-generated
+js/yarn.lock -diff
+
+* text=auto eol=lf

package/boilerplate/skeleton/extension/.github/workflows/backend.yml

@@ -0,0 +1,15 @@
+name: <%= params.extensionName %> PHP
+
+on: [workflow_dispatch, push, pull_request]
+
+# The reusable workflow definitions will be moved to the `flarum/framework` repo soon.
+# This will break your current script.
+# When this happens, run `flarum-cli audit infra --fix` to update your infrastructure.
+
+jobs:
+  run:
+    uses: flarum/.github/.github/workflows/REUSABLE_backend.yml@main
+    with:
+      enable_backend_testing: <%= modules.backendTesting %>
+
+      backend_directory: <%= params.backendDirectory %>

package/boilerplate/skeleton/extension/.github/workflows/frontend.yml

@@ -0,0 +1,20 @@
+name: <%= params.extensionName %> JS
+
+on: [workflow_dispatch, push, pull_request]
+
+# The reusable workflow definitions will be moved to the `flarum/framework` repo soon.
+# This will break your current script.
+# When this happens, run `flarum-cli audit infra --fix` to update your infrastructure.
+
+jobs:
+  run:
+    uses: flarum/.github/.github/workflows/REUSABLE_frontend.yml@main
+    with:
+      enable_bundlewatch: <%= modules.bundlewatch %>
+      enable_prettier: <%= modules.prettier %>
+      enable_typescript: <%= modules.typescript %>
+
+      frontend_directory: <%= params.frontendDirectory %>
+      main_git_branch: <%= params.mainGitBranch %>
+    secrets:
+      bundlewatch_github_token: ${{ secrets.BUNDLEWATCH_GITHUB_TOKEN }}

package/boilerplate/skeleton/extension/.styleci.yml

@@ -0,0 +1,14 @@
+preset: recommended
+
+enabled:
+  - logical_not_operators_with_successor_space
+
+disabled:
+  - align_double_arrow
+  - blank_line_after_opening_tag
+  - multiline_array_trailing_comma
+  - new_with_braces
+  - phpdoc_align
+  - phpdoc_order
+  - phpdoc_separation
+  - phpdoc_types

package/boilerplate/skeleton/extension/LICENSE.md

@@ -0,0 +1 @@
+<%= params.licenseText %>

package/boilerplate/skeleton/extension/README.md

@@ -1,27 +1,27 @@
-# <%= extensionName %>
+# <%= params.extensionName %>
 
-![License](https://img.shields.io/badge/license-<%= licenseType %>-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/<%= packageName %>.svg)](https://packagist.org/packages/<%= packageName %>) [![Total Downloads](https://img.shields.io/packagist/dt/<%= packageName %>.svg)](https://packagist.org/packages/<%= packageName %>)
+![License](https://img.shields.io/badge/license-<%= params.licenseType %>-blue.svg) [![Latest Stable Version](https://img.shields.io/packagist/v/<%= params.packageName %>.svg)](https://packagist.org/packages/<%= params.packageName %>) [![Total Downloads](https://img.shields.io/packagist/dt/<%= params.packageName %>.svg)](https://packagist.org/packages/<%= params.packageName %>)
 
-A [Flarum](http://flarum.org) extension. <%= packageDescription %>
+A [Flarum](http://flarum.org) extension. <%= params.packageDescription %>
 
 ## Installation
 
 Install with composer:
 
 ```sh
-composer require <%= packageName %>:"*"
+composer require <%= params.packageName %>:"*"
 ```
 
 ## Updating
 
 ```sh
-composer update <%= packageName %>:"*"
+composer update <%= params.packageName %>:"*"
 php flarum migrate
 php flarum cache:clear
 ```
 
 ## Links
 
-- [Packagist](https://packagist.org/packages/<%= packageName %>)
-- [GitHub](https://github.com/<%= packageName %>)
+- [Packagist](https://packagist.org/packages/<%= params.packageName %>)
+- [GitHub](https://github.com/<%= params.packageName %>)
 - [Discuss](https://discuss.flarum.org/d/PUT_DISCUSS_SLUG_HERE)

package/boilerplate/skeleton/extension/composer.json

@@ -1,37 +1,39 @@
 {
-    "name": "<%= packageName %>",<% if (packageDescription) { %>
-    "description": "<%= packageDescription %>",<% } %>
+    "name": "<%= params.packageName %>",<% if (params.packageDescription) { %>
+    "description": "<%= params.packageDescription %>",<% } %>
     "keywords": [
         "flarum"
     ],
     "type": "flarum-extension",
-    "license": "<%= licenseType %>",
+    "license": "<%= params.licenseType %>",
     "require": {
         "flarum/core": "^1.0.0"
     },
     "require-dev": {
         "flarum/testing": "^1.0.0"
     },
-    "authors": [<% if (authorName && authorEmail) { %>
+    "authors": [<% if (params.authorName) { %>
         {
-            "name": "<%= authorName %>",<% if (authorEmail) { %>
-            "email": "<%= authorEmail %>",<% } %>
+            "name": "<%= params.authorName %>",<% if (params.authorEmail) { %>
+            "email": "<%= params.authorEmail %>",<% } %>
             "role": "Developer"
         }
     <% } %>],
+    <% if (params.packageNamespace) { %>
     "autoload": {
         "psr-4": {
-            "<%= packageNamespace %>\\": "src/"
+            "<%= params.packageNamespaceEscapedSlash %>\\": "src/"
         }
     },
+    <% } %>
     "autoload-dev": {
         "psr-4": {
-            "<%= packageNamespace %>\\Tests\\": "tests/"
+            "<%= params.packageNamespaceEscapedSlash %>\\Tests\\": "tests/"
         }
     },
     "extra": {
         "flarum-extension": {
-            "title": "<%= extensionName %>",
+            "title": "<%= params.extensionName %>",
             "category": "",
             "icon": {
                 "name": "",

package/boilerplate/skeleton/extension/extend.php

@@ -1,24 +1,24 @@
 <?php
 
 /*
- * This file is part of <%= packageName %>.
+ * This file is part of <%= params.packageName %>.
  *
- * Copyright (c) <%= year %> <%= authorName %>.
+ * Copyright (c) <%= params.year %> <%= params.authorName %>.
  *
  * For the full copyright and license information, please view the LICENSE.md
  * file that was distributed with this source code.
  */
 
-namespace <%= namespace %>;
+namespace <%= params.packageNamespace %>;
 
 use Flarum\Extend;
 
 return [
-    <% if (forum) { %>(new Extend\Frontend('forum'))
-        <% if (useJs) { %>->js(__DIR__.'/js/dist/forum.js')<% if (!useCss) { %>,<% } %><% } %>
-        <% if (useCss) { %>->css(__DIR__.'/less/forum.less'),<% } %><% } %>
-    <% if (admin) { %>(new Extend\Frontend('admin'))
-        <% if (useJs) { %>->js(__DIR__.'/js/dist/admin.js')<% if (!useCss) { %>,<% } %><% } %>
-        <% if (useCss) { %>->css(__DIR__.'/less/admin.less'),<% } %><% } %>
-    <% if (useLocale) { %>new Extend\Locales(__DIR__.'/locale'),<% } %>
+    <% if (modules.forum) { %>(new Extend\Frontend('forum'))
+        <% if (modules.js) { %>->js(__DIR__.'/js/dist/forum.js')<% if (!modules.css) { %>,<% } %><% } %>
+        <% if (modules.css) { %>->css(__DIR__.'/less/forum.less'),<% } %><% } %>
+    <% if (modules.admin) { %>(new Extend\Frontend('admin'))
+        <% if (modules.js) { %>->js(__DIR__.'/js/dist/admin.js')<% if (!modules.css) { %>,<% } %><% } %>
+        <% if (modules.css) { %>->css(__DIR__.'/less/admin.less'),<% } %><% } %>
+    <% if (modules.locale) { %>new Extend\Locales(__DIR__.'/locale'),<% } %>
 ];

package/boilerplate/skeleton/extension/gitignore

@@ -0,0 +1,12 @@
+/vendor
+composer.lock
+composer.phar
+
+.DS_Store
+Thumbs.db
+tests/.phpunit.result.cache
+/tests/integration/tmp
+.vagrant
+.idea/*
+.vscode
+js/coverage-ts

package/boilerplate/skeleton/extension/js/.bundlewatch.config.json

@@ -0,0 +1,8 @@
+{
+    "files": [
+        {
+            "path": "./dist/*.js"
+        }
+    ],
+    "defaultCompression": "gzip"
+}

package/boilerplate/skeleton/extension/js/admin.js

@@ -1 +1,2 @@
-export * from './src/admin';
+<% if (modules.jsCommon) { %>export * from './src/common';
+<% } %>export * from './src/admin';

package/boilerplate/skeleton/extension/js/admin.ts

@@ -0,0 +1,2 @@
+<% if (modules.jsCommon) { %>export * from './src/common';
+<% } %>export * from './src/admin';

package/boilerplate/skeleton/extension/js/forum.js

@@ -1 +1,2 @@
-export * from './src/forum';
+<% if (modules.jsCommon) { %>export * from './src/common';
+<% } %>export * from './src/forum';

package/boilerplate/skeleton/extension/js/forum.ts

@@ -0,0 +1,2 @@
+<% if (modules.jsCommon) { %>export * from './src/common';
+<% } %>export * from './src/forum';

package/boilerplate/skeleton/extension/js/gitignore

@@ -0,0 +1,9 @@
+.pnp.*
+.yarn/*
+!.yarn/patches
+!.yarn/plugins
+!.yarn/releases
+!.yarn/sdks
+!.yarn/versions
+
+node_modules

package/boilerplate/skeleton/extension/js/package.json

@@ -1,22 +1,26 @@
 {
-  "name": "@<%= packageName %>",
-  "version": "0.0.0",
+  "name": "@<%= params.packageName %>",
   "private": true,
   "prettier": "@flarum/prettier-config",
   "dependencies": {
-    "flarum-webpack-config": "^1.0.0",
-    "flarum-tsconfig": "^1.0.0",
-    "@flarum/prettier-config": "^1.0.0",
-    "webpack": "^4.26.0",
-    "webpack-cli": "^3.0.7"
   },
   "devDependencies": {
-    "prettier": "^2.3.0"
+    "@flarum/prettier-config": "^1.0.0",
+    "flarum-tsconfig": "^1.0.2",
+    "flarum-webpack-config": "^2.0.0",
+    "prettier": "^2.5.1",
+    "typescript": "^4.5.4",
+    "typescript-coverage-report": "^0.6.1",
+    "webpack": "^5.65.0",
+    "webpack-cli": "^4.9.1"
   },
   "scripts": {
     "dev": "webpack --mode development --watch",
     "build": "webpack --mode production",
+    "analyze": "cross-env ANALYZER=true yarn build",
     "format": "prettier --write src",
-    "format-check": "prettier --check src"
+    "format-check": "prettier --check src",
+    "check-typings": "tsc --noEmit --emitDeclarationOnly false",
+    "check-typings-coverage": "typescript-coverage-report"
   }
 }

package/boilerplate/skeleton/extension/js/src/admin/index.js

@@ -1,3 +1,5 @@
-app.initializers.add('<%= packageName %>', () => {
-  console.log('[<%= packageName %>] Hello, admin!');
+import app from 'flarum/admin/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, admin!');
 });

package/boilerplate/skeleton/extension/js/src/admin/index.ts

@@ -0,0 +1,5 @@
+import app from 'flarum/admin/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, admin!');
+});

package/boilerplate/skeleton/extension/js/src/common/index.js

@@ -0,0 +1,5 @@
+import app from 'flarum/common/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, forum and admin!');
+});

package/boilerplate/skeleton/extension/js/src/common/index.ts

@@ -0,0 +1,5 @@
+import app from 'flarum/common/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, forum and admin!');
+});

package/boilerplate/skeleton/extension/js/src/forum/index.js

@@ -1,3 +1,5 @@
-app.initializers.add('<%= packageName %>', () => {
-  console.log('[<%= packageName %>] Hello, forum!');
+import app from 'flarum/forum/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, forum!');
 });

package/boilerplate/skeleton/extension/js/src/forum/index.ts

@@ -0,0 +1,5 @@
+import app from 'flarum/forum/app';
+
+app.initializers.add('<%= params.packageName %>', () => {
+  console.log('[<%= params.packageName %>] Hello, forum!');
+});

package/boilerplate/skeleton/extension/js/tsconfig.json

@@ -1,7 +1,12 @@
 {
+  // Use Flarum's tsconfig as a starting point
   "extends": "flarum-tsconfig",
-  "include": ["src/**/*"],
+  // This will match all .ts, .tsx, .d.ts, .js, .jsx files in your `src` folder
+  // and also tells your Typescript server to read core's global typings for
+  // access to `dayjs` and `$` in the global namespace.
+  "include": ["src/**/*", "../vendor/flarum/core/js/dist-typings/@types/**/*", "@types/**/*"],
   "compilerOptions": {
+    // This will output typings to `dist-typings`
     "declarationDir": "./dist-typings",
     "baseUrl": ".",
     "paths": {

package/boilerplate/skeleton/extension/locale/en.yml

@@ -1,4 +1,4 @@
-<%= extensionId %>:
+<%= params.extensionId %>:
   # For more details on the format
   # Checkout https://docs.flarum.org/extend/i18n.html#appendix-a-standard-key-format
   admin:

package/boilerplate/stubs/migration.php

@@ -5,7 +5,7 @@ use Illuminate\Database\Schema\Blueprint;
 use Illuminate\Database\Schema\Builder;
 
 // HINT: you might want to use a `Flarum\Database\Migration` helper method for simplicity!
-// See https://docs.flarum.org/extend/data.html#migrations to learn more about migrations.
+// See https://docs.flarum.org/extend/models.html#migrations to learn more about migrations.
 return [
     'up' => function (Builder $schema) {
         // up migration

package/lib/base-command.d.ts

@@ -1,7 +1,19 @@
-import { Command, flags } from '@oclif/command';
-import { StepManager } from './steps/step-manager';
+import { Command, Interfaces } from '@oclif/core';
+import { IO } from 'boilersmith/io';
+import { StepManager } from 'boilersmith/step-manager';
+import { FlarumProviders } from './providers';
+export declare enum LocationType {
+    FLARUM_EXTENSION = 0,
+    FLARUM_CORE = 1,
+    FLARUM_MONOREPO = 2
+}
 export default abstract class BaseCommand extends Command {
-    static flags: flags.Input<any>;
+    protected STUB_PATH: string;
+    protected dry: boolean;
+    protected locationType?: LocationType;
+    protected args: Record<string, any>;
+    protected flags: any;
+    static flags: Interfaces.FlagInput<any>;
     static args: {
         name: string;
         description: string;
@@ -11,8 +23,19 @@ export default abstract class BaseCommand extends Command {
     protected welcomeMessage(): string;
     protected goodbyeMessage(): string;
     protected additionalPreRunChecks(_extRoot: string): Promise<void>;
-    protected abstract steps(stepManager: StepManager): StepManager;
-    protected getFlarumExtensionRoot(currDir: string): Promise<string>;
+    protected abstract steps(stepManager: StepManager<FlarumProviders>): StepManager<FlarumProviders>;
+    protected genIO(): IO;
+    protected monorepoPaths(options: {
+        includeCore: boolean;
+        includeExtensions: boolean;
+        includePhpPackages: boolean;
+        includeJSPackages: boolean;
+    }): string[];
+    protected isFlarumCore(path: string): boolean;
+    protected getFlarumExtensionRoot(currDir: string): Promise<{
+        path: string;
+        type: LocationType;
+    }>;
     protected confirmExtDir(extRoot: string): Promise<void>;
     protected ensureComposerInstallRan(extRoot: string): Promise<void>;
     /**
@@ -20,6 +43,6 @@ export default abstract class BaseCommand extends Command {
      * If true, files should be overriden.
      * If user says no, will exit and not return anything.
      */
-    protected confirmOverrideFiles(dir: string, pattern: string, confirmationMessage: string): Promise<boolean>;
+    protected confirmOverrideFiles(dir: string, pattern: string | string[], confirmationMessage: string): Promise<boolean>;
     protected deleteFiles(dir: string, pattern: string): Promise<void>;
 }