Update plugin generator to generate NP plugins

packages/kbn-plugin-generator/integration_tests/generate_plugin.test.js

@@ -61,6 +61,7 @@ describe(`running the plugin-generator via 'node scripts/generate_plugin.js plug
     expect(stats.isDirectory()).toBe(true);
   });
 
+  // skipped until internationalization is re-introduced
   it.skip(`should create an internationalization config file with a blank line appended to satisfy the parser`, async () => {
     // Link to the error that happens when the blank line is not there:
     // https://github.com/elastic/kibana/pull/45044#issuecomment-530092627
@@ -78,15 +79,6 @@ describe(`running the plugin-generator via 'node scripts/generate_plugin.js plug
       });
     });
 
-    it.skip(`'yarn test:server' should exit 0`, async () => {
-      await execa('yarn', ['test:server'], {
-        cwd: generatedPath,
-        env: {
-          DISABLE_JUNIT_REPORTER: '1',
-        },
-      });
-    });
-
     it.skip(`'yarn build' should exit 0`, async () => {
       await execa('yarn', ['build'], { cwd: generatedPath });
     });
@@ -98,7 +90,7 @@ describe(`running the plugin-generator via 'node scripts/generate_plugin.js plug
       beforeAll(es.start);
       afterAll(es.stop);
 
-      it.skip(`'yarn start' should result in the spec plugin being initialized on kibana's stdout`, async () => {
+      it(`'yarn start' should result in the spec plugin being initialized on kibana's stdout`, async () => {
         await withProcRunner(log, async proc => {
           await proc.run('kibana', {
             cmd: 'yarn',
@@ -109,7 +101,7 @@ describe(`running the plugin-generator via 'node scripts/generate_plugin.js plug
               '--migrations.skip=true',
             ],
             cwd: generatedPath,
-            wait: /ispec_plugin.+Status changed from uninitialized to green - Ready/,
+            wait: /ispec_plugin.+Setting up plugin/,
           });
           await proc.stop('kibana');
         });

packages/kbn-plugin-generator/sao_template/sao.js

@@ -61,13 +61,19 @@ module.exports = function({ name, targetPath, isKibanaPlugin }) {
         when: answers => answers.generateApp,
         default: true,
       },
+      generateEslint: {
+        type: 'confirm',
+        message: 'Should generate custom eslint file be used?',
+        default: !isKibanaPlugin,
+      },
     },
     filters: {
       'public/**/index.scss': 'generateScss',
       'public/**/*': 'generateApp',
       'server/**/*': 'generateApi',
       'translations/**/*': 'generateTranslations',
       '.i18nrc.json': 'generateTranslations',
+      'eslintrc.js': 'generateEslint',
     },
     move: {
       'eslintrc.js': '.eslintrc.js',

packages/kbn-plugin-generator/sao_template/sao.test.js

@@ -19,8 +19,6 @@
 
 const sao = require('sao');
 
-const templatePkg = require('../package.json');
-
 const template = {
   fromPath: __dirname,
   configOptions: {
@@ -32,29 +30,16 @@ function getFileContents(file) {
   return file.contents.toString();
 }
 
-function getConfig(file) {
-  const contents = getFileContents(file).replace(/\r?\n/gm, '');
-  return contents.split('kibana.Plugin(')[1];
-}
-
 describe('plugin generator sao integration', () => {
-  test.skip('skips files when answering no', async () => {
+  test('skips files when answering no', async () => {
     const res = await sao.mockPrompt(template, {
       generateApp: false,
       generateApi: false,
     });
 
-    expect(res.fileList).not.toContain('public/app.js');
-    expect(res.fileList).not.toContain('public/__tests__/index.js');
-    expect(res.fileList).not.toContain('public/hack.js');
-    expect(res.fileList).not.toContain('server/routes/example.js');
-    expect(res.fileList).not.toContain('server/__tests__/index.js');
-
-    const uiExports = getConfig(res.files['index.js']);
-    expect(uiExports).not.toContain('app:');
-    expect(uiExports).not.toContain('hacks:');
-    expect(uiExports).not.toContain('init(server, options)');
-    expect(uiExports).not.toContain('registerFeature(');
+    expect(res.fileList).toContain('common/index.ts');
+    expect(res.fileList).not.toContain('public/index.ts');
+    expect(res.fileList).not.toContain('server/index.ts');
   });
 
   it('includes app when answering yes', async () => {
@@ -69,26 +54,21 @@ describe('plugin generator sao integration', () => {
     expect(res.fileList).toContain('public/plugin.ts');
     expect(res.fileList).toContain('public/types.ts');
     expect(res.fileList).toContain('public/components/app.tsx');
+    expect(res.fileList).not.toContain('server/index.ts');
   });
 
-  it.skip('includes server api when answering yes', async () => {
+  it('includes server api when answering yes', async () => {
     const res = await sao.mockPrompt(template, {
       generateApp: true,
       generateApi: true,
     });
 
     // check output files
-    expect(res.fileList).toContain('public/app.js');
-    expect(res.fileList).toContain('public/__tests__/index.js');
-    expect(res.fileList).toContain('public/hack.js');
-    expect(res.fileList).toContain('server/routes/example.js');
-    expect(res.fileList).toContain('server/__tests__/index.js');
-
-    const uiExports = getConfig(res.files['index.js']);
-    expect(uiExports).toContain('app:');
-    expect(uiExports).toContain('hacks:');
-    expect(uiExports).toContain('init(server, options)');
-    expect(uiExports).toContain('registerFeature(');
+    expect(res.fileList).toContain('public/plugin.ts');
+    expect(res.fileList).toContain('server/plugin.ts');
+    expect(res.fileList).toContain('server/index.ts');
+    expect(res.fileList).toContain('server/types.ts');
+    expect(res.fileList).toContain('server/routes/index.ts');
   });
 
   it('plugin package has correct title', async () => {
@@ -125,17 +105,6 @@ describe('plugin generator sao integration', () => {
     expect(pkg.version).toBe('v6.0.0');
   });
 
-  it.skip('package has correct templateVersion', async () => {
-    const res = await sao.mockPrompt(template, {
-      kbnVersion: 'master',
-    });
-
-    const packageContents = getFileContents(res.files['kibana.json']);
-    const pkg = JSON.parse(packageContents);
-
-    expect(pkg.kibana.templateVersion).toBe(templatePkg.version);
-  });
-
   it('sample app has correct values', async () => {
     const res = await sao.mockPrompt(template, {
       generateApp: true,
@@ -148,9 +117,8 @@ describe('plugin generator sao integration', () => {
     expect(controllerLine).toContain('someFancyPlugin');
   });
 
-  it.skip('includes dotfiles', async () => {
+  it('includes dotfiles', async () => {
     const res = await sao.mockPrompt(template);
-    expect(res.files['.gitignore']).toBeTruthy();
     expect(res.files['.eslintrc.js']).toBeTruthy();
   });
 });

packages/kbn-plugin-generator/sao_template/template/README.md

@@ -6,7 +6,7 @@
 
 ---
 
-## development
+## Development
 
-See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment. Once you have completed that, use the following yarn scripts.
+See the [kibana contributing guide](https://github.com/elastic/kibana/blob/master/CONTRIBUTING.md) for instructions setting up your development environment.
 

packages/kbn-plugin-generator/sao_template/template/public/components/app.tsx

@@ -103,7 +103,7 @@ export const <%= upperCamelCaseName %>App = ({ basename, notifications, http, na
                     <p>
                       <FormattedMessage
                         id="<%= camelCase(name) %>.content"
-                        defaultMessage="Look through the generated code and checkout the plugin development documentation."
+                        defaultMessage="Look through the generated code and check out the plugin development documentation."
                       />
                     </p>
                     <EuiHorizontalRule/>

packages/kbn-plugin-generator/sao_template/template/public/index.ts

@@ -2,12 +2,17 @@
 import './index.scss';
 <%_ } -%>
 
-import { <%= upperCamelCaseName %>PublicPlugin } from './plugin';
+import { <%= upperCamelCaseName %>Plugin } from './plugin';
 
+/**
+ * This exports static code and TypeScript types, 
+ * as well as, Kibana Platform `plugin()` initializer.
+ **/ 
 export function plugin() {
-  return new <%= upperCamelCaseName %>PublicPlugin();
+  return new <%= upperCamelCaseName %>Plugin();
 }
-
-export * from '../common';
-export * from './types';
+export {
+  <%= upperCamelCaseName %>PluginSetup,
+  <%= upperCamelCaseName %>PluginStart,
+} from './types';
 

packages/kbn-plugin-generator/sao_template/template/public/plugin.ts

@@ -1,12 +1,12 @@
 import { i18n } from '@kbn/i18n';
 import { AppMountParameters, CoreSetup, CoreStart, Plugin } from '<%= relRoot %>/src/core/public';
-import { <%= upperCamelCaseName %>PublicPluginSetup, <%= upperCamelCaseName %>PublicPluginStart, AppPluginDependencies } from './types';
+import { <%= upperCamelCaseName %>PluginSetup, <%= upperCamelCaseName %>PluginStart, AppPluginDependencies } from './types';
 import { PLUGIN_NAME } from '../common';
 
-export class <%= upperCamelCaseName %>PublicPlugin
-  implements Plugin<<%= upperCamelCaseName %>PublicPluginSetup, <%= upperCamelCaseName %>PublicPluginStart> {
+export class <%= upperCamelCaseName %>Plugin
+  implements Plugin<<%= upperCamelCaseName %>PluginSetup, <%= upperCamelCaseName %>PluginStart> {
 
-  public setup(core: CoreSetup): <%= upperCamelCaseName %>PublicPluginSetup {
+  public setup(core: CoreSetup): <%= upperCamelCaseName %>PluginSetup {
     // Register an application into the side navigation menu
     core.application.register({
       id: '<%= camelCase(name) %>',
@@ -34,7 +34,7 @@ export class <%= upperCamelCaseName %>PublicPlugin
     };
   }
 
-  public start(core: CoreStart): <%= upperCamelCaseName %>PublicPluginStart {
+  public start(core: CoreStart): <%= upperCamelCaseName %>PluginStart {
     return {};
   }
 

packages/kbn-plugin-generator/sao_template/template/public/types.ts

@@ -1,10 +1,10 @@
 import { NavigationPublicPluginStart } from '<%= relRoot %>/src/plugins/navigation/public';
 
-export interface <%= upperCamelCaseName %>PublicPluginSetup {
+export interface <%= upperCamelCaseName %>PluginSetup {
   getGreeting: () => string;
 }
 // eslint-disable-next-line @typescript-eslint/no-empty-interface
-export interface <%= upperCamelCaseName %>PublicPluginStart {}
+export interface <%= upperCamelCaseName %>PluginStart {}
 
 export interface AppPluginDependencies { 
   navigation: NavigationPublicPluginStart 

packages/kbn-plugin-generator/sao_template/template/server/index.ts

@@ -1,9 +1,15 @@
 import { PluginInitializerContext } from '<%= relRoot %>/src/core/server';
-import { <%= upperCamelCaseName %>ServerPlugin } from './plugin';
+import { <%= upperCamelCaseName %>Plugin } from './plugin';
 
-export function plugin(initializerContext: PluginInitializerContext) {
-  return new <%= upperCamelCaseName %>ServerPlugin(initializerContext);
+/**
+ * This exports static code and TypeScript types, 
+ * as well as, Kibana Platform `plugin()` initializer.
+ **/ 
+ export function plugin(initializerContext: PluginInitializerContext) {
+  return new <%= upperCamelCaseName %>Plugin(initializerContext);
 }
 
-export { <%= upperCamelCaseName %>ServerPlugin as Plugin };
-export * from '../common';
+export {
+  <%= upperCamelCaseName %>PluginSetup,
+  <%= upperCamelCaseName %>PluginStart,
+} from './types';

packages/kbn-plugin-generator/sao_template/template/server/plugin.ts

@@ -3,7 +3,7 @@ import { PluginInitializerContext, CoreSetup, CoreStart, Plugin, Logger } from '
 import { <%= upperCamelCaseName %>PluginSetup, <%= upperCamelCaseName %>PluginStart } from './types';
 import { defineRoutes } from './routes';
 
-export class <%= upperCamelCaseName %>ServerPlugin
+export class <%= upperCamelCaseName %>Plugin
   implements Plugin<<%= upperCamelCaseName %>PluginSetup, <%= upperCamelCaseName %>PluginStart> {
   private readonly logger: Logger;
 
@@ -12,7 +12,7 @@ export class <%= upperCamelCaseName %>ServerPlugin
   }
 
   public setup(core: CoreSetup) {
-    this.logger.debug('<%= name %>: Ssetup');
+    this.logger.debug('<%= name %>: Setup');
     const router = core.http.createRouter();
 
     // Register server side APIs
@@ -28,5 +28,3 @@ export class <%= upperCamelCaseName %>ServerPlugin
 
   public stop() {}
 }
-
-export { <%= upperCamelCaseName %>ServerPlugin as Plugin };