Option in TSConfig to include hidden/dot files

[regseb]

Suggestion

🔍 Search Terms

hidden, dot, dotfile, include, tsconfig.

✅ Viability Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Add an option in TSConfig to include hidden files (and hidden directories) in include and exclude options.

{
    "hidden": true,
    "include": ["**/*"],
}

Other alternative names for hidden:

• dot like in:
  • node-glob: Include .dot files in normal matches and globstar matches. Note that an explicit dot in a portion of the pattern will always match dot files.
  • globby and fast-glob: Allow patterns to match entries that begin with a period (.).
  • tinyglobby: Whether to allow entries starting with a dot.
• dotfiles like in express and serve-static (it used hidden before): Determines how dotfiles (files or directories that begin with a dot “.”) are treated.
• includeDot and excludeDot by silverwind: #49555 (comment)

📃 Motivating Example

Proposal for wildcard documentation:

include and exclude support wildcard characters to make glob patterns:

• * matches zero or more characters (excluding directory separators and hidden file if hidden is set to false)
• ? matches any one character (excluding directory separators)
• **/ matches any directory nested to any level (excluding hidden directory if hidden is set to false)

💻 Use Cases

I want to scan all files in my project, even hidden files and files in a hidden directory. I use this TSConfig (⚠️ which doesn't list files in two hidden directories, e.g. .foo/.bar/baz.ts):

{
    "include": [
        "**/*",
        "**/.*",
        "**/.*/**/*",
        "**/.*/**/.*"
    ]
}

🔗 Related Issues

• tsconfig paths not work if dir name start with dot. #36922

[doktordirk]

Use case: .storybook folder

[dartess]

Thans for workaround.
After updating to version @5, I began to get errors in the IDE in storybook files.

[ernestostifano]

Having issues with .storybook folder too

[psychobolt]

Even in TS 5.0, .storybook or any dot folders needs to be explicitly included in config.

[SalvatorePreviti]

This is particularly problematic with typescript eslint:

Parsing error: ESLint was configured to run on <tsconfigRootDir>/packages/eslint-config/.prettierrc.js using parserOptions.project: folder/tsconfig.json
However, that TSConfig does not include this file. Either:
- Change ESLint's list of included files to not include this file
- Change that TSConfig to include this file
- Create a new TSConfig that includes this file and include it in your parserOptions.project
See the typescript-eslint docs for more info: https://typescript-eslint.io/linting/troubleshooting#i-get-errors-telling-me-eslint-was-configured-to-run--however-that-tsconfig-does-not--none-of-those-tsconfigs-include-this-file

[silverwind]

I would not name the option hidden (which is too ambigous), but includeDot and excludeDot.

[serious-angel]

I would not name the option hidden (which is too ambigous), but includeDot and excludeDot.

This is correct. "Hidden" depends on the environment. In case of Linux, yes, but still depends on the filesystem and some don't have EXT4, hence "dotfiles".

What about Windows? Please correct if mistaken, but in Windows, you have NTFS with both prefixes like $ and file metadata as hidden and system referenced in file header attributes.

Related

• Defeating Forensic Analysis on Unix File Systems

[ryallen-nokia]

Use case: .storybook folder

Adding .storybook/**/* to the config include array works.

[MonstraG]

Today got bit by the fact that hidden files are ignored because it was refusing to look at .eslintrc.js

[bostrom]

In the Storybook case (using typescript-eslint), the following worked for me:

.tsconfig

  "include": [
    ".storybook/**/*"
  ],

.eslintrc

  ignorePatterns: [
    '!.storybook',
  ],