Automatically add featureFlags.future flags to the configuration fi…

…les whenever the `init` command is ran (#2379) * Add --future flag to CLI * Remove early exit * Always add future flags but commented out - Update replace regex - Remove future CLI flag - Update tests
tailwindlabs · Oct 7, 2020 · f72158c · f72158c
1 parent 9d29f3f
commit f72158c
Show file tree

Hide file tree

Showing 4 changed files with 30 additions and 16 deletions.
diff --git a/__tests__/cli.test.js b/__tests__/cli.test.js
@@ -4,12 +4,11 @@ import cli from '../src/cli/main'
 import * as constants from '../src/constants'
 import * as utils from '../src/cli/utils'
 import runInTempDirectory from '../jest/runInTempDirectory'
+import featureFlags from '../src/featureFlags'
 
 describe('cli', () => {
   const inputCssPath = path.resolve(__dirname, 'fixtures/tailwind-input.css')
   const customConfigPath = path.resolve(__dirname, 'fixtures/custom-config.js')
-  const defaultConfigFixture = utils.readFile(constants.defaultConfigStubFile)
-  const simpleConfigFixture = utils.readFile(constants.simpleConfigStubFile)
   const defaultPostCssConfigFixture = utils.readFile(constants.defaultPostCssConfigStubFile)
 
   beforeEach(() => {
@@ -21,15 +20,15 @@ describe('cli', () => {
     it('creates a Tailwind config file', () => {
       return runInTempDirectory(() => {
         return cli(['init']).then(() => {
-          expect(utils.readFile(constants.defaultConfigFile)).toEqual(simpleConfigFixture)
+          expect(utils.exists(constants.defaultConfigFile)).toEqual(true)
         })
       })
     })
 
     it('creates a Tailwind config file and a postcss.config.js file', () => {
       return runInTempDirectory(() => {
         return cli(['init', '-p']).then(() => {
-          expect(utils.readFile(constants.defaultConfigFile)).toEqual(simpleConfigFixture)
+          expect(utils.exists(constants.defaultConfigFile)).toEqual(true)
           expect(utils.readFile(constants.defaultPostCssConfigFile)).toEqual(
             defaultPostCssConfigFixture
           )
@@ -40,7 +39,7 @@ describe('cli', () => {
     it('creates a full Tailwind config file', () => {
       return runInTempDirectory(() => {
         return cli(['init', '--full']).then(() => {
-          expect(utils.readFile(constants.defaultConfigFile)).toEqual(defaultConfigFixture)
+          expect(utils.exists(constants.defaultConfigFile)).toEqual(true)
         })
       })
     })
@@ -94,5 +93,15 @@ describe('cli', () => {
         expect(process.stdout.write.mock.calls[0][0]).not.toContain('-ms-input-placeholder')
       })
     })
+
+    it('creates a Tailwind config file with future flags', () => {
+      return runInTempDirectory(() => {
+        return cli(['init']).then(() => {
+          featureFlags.future.forEach(flag => {
+            expect(utils.readFile(constants.defaultConfigFile)).toContain(`${flag}: true`)
+          })
+        })
+      })
+    })
   })
 })
diff --git a/src/cli/commands/init.js b/src/cli/commands/init.js
@@ -35,15 +35,26 @@ export function run(cliParams, cliOptions) {
   return new Promise(resolve => {
     utils.header()
 
-    const full = cliOptions.full
     const file = cliParams[0] || constants.defaultConfigFile
     const simplePath = utils.getSimplePath(file)
 
     utils.exists(file) && utils.die(colors.file(simplePath), 'already exists.')
 
-    const stubFile = full ? constants.defaultConfigStubFile : constants.simpleConfigStubFile
+    const stubFile = cliOptions.full
+      ? constants.defaultConfigStubFile
+      : constants.simpleConfigStubFile
 
-    utils.copyFile(stubFile, file)
+    const config = require(stubFile)
+    const { future: flags } = require('../../featureFlags').default
+
+    flags.forEach(flag => {
+      config.future[`// ${flag}`] = true
+    })
+
+    utils.writeFile(
+      file,
+      `module.exports = ${JSON.stringify(config, null, 2).replace(/"([^-_\d"]+)":/g, '$1:')}\n`
+    )
 
     utils.log()
     utils.log(emoji.yes, 'Created Tailwind config file:', colors.file(simplePath))

diff --git a/stubs/defaultConfig.stub.js b/stubs/defaultConfig.stub.js
@@ -1,8 +1,5 @@
 module.exports = {
-  future: {
-    // removeDeprecatedGapUtilities: true,
-    // purgeLayersByDefault: true,
-  },
+  future: {},
   purge: [],
   target: 'relaxed',
   prefix: '',

diff --git a/stubs/simpleConfig.stub.js b/stubs/simpleConfig.stub.js
@@ -1,8 +1,5 @@
 module.exports = {
-  future: {
-    // removeDeprecatedGapUtilities: true,
-    // purgeLayersByDefault: true,
-  },
+  future: {},
   purge: [],
   theme: {
     extend: {},