improvement: add repl environment to make:prldfile command

Author: thetutlage

commands/Make/PreloadFile.ts

@@ -25,7 +25,7 @@ export default class MakePreloadFile extends BaseGenerator {
 	/**
 	 * List of allowed environments
 	 */
-	private allowedEnvironments = ['console', 'web', 'test']
+	private allowedEnvironments = ['console', 'web', 'repl']
 
 	/**
 	 * Command name
@@ -42,7 +42,7 @@ export default class MakePreloadFile extends BaseGenerator {
 	public name: string
 
 	@flags.string({
-		description: 'Explicitly define the environment in which you want to load this file',
+		description: 'Define the environment in which you want to load this file',
 		async defaultValue(command: MakePreloadFile) {
 			return command.prompt.multiple(
 				'Select the environment(s) in which you want to load this file',
@@ -51,6 +51,10 @@ export default class MakePreloadFile extends BaseGenerator {
 						name: 'console',
 						message: 'During ace commands',
 					},
+					{
+						name: 'repl',
+						message: 'During repl session',
+					},
 					{
 						name: 'web',
 						message: 'During HTTP server',
@@ -64,15 +68,15 @@ export default class MakePreloadFile extends BaseGenerator {
 			)
 		},
 	})
-	public environment: ('console' | 'web')[]
+	public environment: ('console' | 'web' | 'repl')[]
 
 	/**
 	 * Validates environments to ensure they are allowed. Especially when
 	 * defined as a flag.
 	 */
 	private validateEnvironments(
 		environments: string[]
-	): environments is ('console' | 'web' | 'test')[] {
+	): environments is ('console' | 'web' | 'repl')[] {
 		return !environments.find((environment) => !this.allowedEnvironments.includes(environment))
 	}
 

npm-audit.html

@@ -55,7 +55,7 @@ <h5 class="card-title">
                 <div class="card">
                     <div class="card-body">
                         <h5 class="card-title">
-                            November 9th 2020, 4:56:16 pm
+                            November 9th 2020, 5:07:24 pm
                         </h5>
                         <p class="card-text">Last updated</p>
                     </div>

test/make-preloaded-file.spec.ts

@@ -44,12 +44,9 @@ test.group('Make Preloaded File', (group) => {
 		preloadFile.environment = 'console,web' as any
 		await preloadFile.run()
 
-		const AppProvider = await fs.get('start/viewGlobals.ts')
-		const ProviderTemplate = await templates.get('preload-file.txt')
-		assert.deepEqual(
-			toNewlineArray(AppProvider),
-			toNewlineArray(ProviderTemplate.replace('{{ filename }}', 'AppProvider'))
-		)
+		const viewGlobals = await fs.get('start/viewGlobals.ts')
+		const preloadTemplate = await templates.get('preload-file.txt')
+		assert.deepEqual(toNewlineArray(viewGlobals), toNewlineArray(preloadTemplate))
 
 		const rcRawContents = await fs.get('.adonisrc.json')
 		assert.deepEqual(JSON.parse(rcRawContents), {
@@ -80,12 +77,9 @@ test.group('Make Preloaded File', (group) => {
 		preloadFile.environment = ['console', 'web']
 		await preloadFile.run()
 
-		const AppProvider = await fs.get('foo/viewGlobals.ts')
-		const ProviderTemplate = await templates.get('preload-file.txt')
-		assert.deepEqual(
-			toNewlineArray(AppProvider),
-			toNewlineArray(ProviderTemplate.replace('{{ filename }}', 'AppProvider'))
-		)
+		const viewGlobals = await fs.get('foo/viewGlobals.ts')
+		const preloadTemplate = await templates.get('preload-file.txt')
+		assert.deepEqual(toNewlineArray(viewGlobals), toNewlineArray(preloadTemplate))
 
 		const rcRawContents = await fs.get('.adonisrc.json')
 		assert.deepEqual(JSON.parse(rcRawContents), {
@@ -98,4 +92,58 @@ test.group('Make Preloaded File', (group) => {
 			],
 		})
 	})
+
+	test('select environment as repl', async (assert) => {
+		await fs.add('.adonisrc.json', JSON.stringify({}))
+
+		const rcContents = importFresh(join(fs.basePath, '.adonisrc.json')) as any
+		const app = new Application(fs.basePath, 'test', rcContents)
+
+		const preloadFile = new PreloadFile(app, new Kernel(app))
+		preloadFile.name = 'repl'
+		preloadFile.environment = ['repl']
+		await preloadFile.run()
+
+		const replFile = await fs.get('start/repl.ts')
+		const preloadTemplate = await templates.get('preload-file.txt')
+		assert.deepEqual(toNewlineArray(replFile), toNewlineArray(preloadTemplate))
+
+		const rcRawContents = await fs.get('.adonisrc.json')
+		assert.deepEqual(JSON.parse(rcRawContents), {
+			preloads: [
+				{
+					file: './start/repl',
+					environment: ['repl'],
+				},
+			],
+		})
+	})
+
+	test('prompt for environment when not explicitly defined', async (assert) => {
+		await fs.add('.adonisrc.json', JSON.stringify({}))
+
+		const rcContents = importFresh(join(fs.basePath, '.adonisrc.json')) as any
+		const app = new Application(fs.basePath, 'test', rcContents)
+
+		const preloadFile = new PreloadFile(app, new Kernel(app))
+		preloadFile.prompt.on('prompt', (question) => {
+			question.select(1)
+		})
+
+		await preloadFile.kernel.runCommand(preloadFile, ['make:prldfile', 'repl'])
+
+		const replFile = await fs.get('start/repl.ts')
+		const preloadTemplate = await templates.get('preload-file.txt')
+		assert.deepEqual(toNewlineArray(replFile), toNewlineArray(preloadTemplate))
+
+		const rcRawContents = await fs.get('.adonisrc.json')
+		assert.deepEqual(JSON.parse(rcRawContents), {
+			preloads: [
+				{
+					file: './start/repl',
+					environment: ['repl'],
+				},
+			],
+		})
+	})
 })