Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add TypeScript types for the tailwind.config.js file #7891

Merged
merged 9 commits into from
Mar 22, 2022
Merged

Add TypeScript types for the tailwind.config.js file #7891

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
db5fe42
add generate-types script
RobinMalfait Mar 18, 2022
72f354b
add types for the `tailwind.config.js` config file
RobinMalfait Mar 18, 2022
e2278f1
annotate stubs with a JSDoc pointing to the types
RobinMalfait Mar 18, 2022
6ea3347
add types to package.json
RobinMalfait Mar 18, 2022
98c5aa8
re-export types top-level
RobinMalfait Mar 18, 2022
c1b0b6a
also publish generated types
RobinMalfait Mar 18, 2022
e1e674f
update changelog
RobinMalfait Mar 18, 2022
cfd3b9c
enable TypeScript only when using `init --types` for now
RobinMalfait Mar 21, 2022
9796edb
update tests to verify that `--types` works
RobinMalfait Mar 21, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
enable TypeScript only when using init --types for now
  • Loading branch information
@RobinMalfait
RobinMalfait committed Mar 21, 2022
commit cfd3b9cc0173d1fe484606dfd2f081a93d412012
13 changes: 12 additions & 1 deletion src/cli.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,10 @@ let commands = {
args: {
'--full': { type: Boolean, description: 'Initialize a full `tailwind.config.js` file' },
'--postcss': { type: Boolean, description: 'Initialize a `postcss.config.js` file' },
'--types': {
type: Boolean,
description: 'Add TypeScript types for the `tailwind.config.js` file',
},
'-f': '--full',
'-p': '--postcss',
},
Expand Down Expand Up @@ -209,7 +213,7 @@ if (
help({
usage: [
'tailwindcss [--input input.css] [--output output.css] [--watch] [options...]',
'tailwindcss init [--full] [--postcss] [options...]',
'tailwindcss init [--full] [--postcss] [--types] [options...]',
],
commands: Object.keys(commands)
.filter((command) => command !== 'build')
Expand Down Expand Up @@ -336,6 +340,13 @@ function init() {
'utf8'
)

if (args['--types']) {
let typesHeading = "/** @type {import('tailwindcss/types').Config} */"
stubFile =
stubFile.replace(`module.exports = `, `${typesHeading}\nconst config = `) +
'\nmodule.exports = config'
}

// Change colors import
stubFile = stubFile.replace('../colors', 'tailwindcss/colors')

Expand Down
5 changes: 1 addition & 4 deletions stubs/defaultConfig.stub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,4 @@
/** @type {import('tailwindcss/types').Config} */
const config = {
module.exports = {
content: [],
presets: [],
darkMode: 'media', // or 'class'
Expand Down Expand Up @@ -952,5 +951,3 @@ const config = {
],
plugins: [],
}

module.exports = config
5 changes: 1 addition & 4 deletions stubs/simpleConfig.stub.js
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,10 +1,7 @@
/** @type {import('tailwindcss/types').Config} */
const config = {
module.exports = {
content: [],
theme: {
extend: {},
},
plugins: [],
}

module.exports = config