Template files starting with an underscore are renamed to a start with a period

[SharpSeeEr]

Version

3.0.0-rc.3

Reproduction link

buefy/vue-cli-plugin-buefy#8 (comment)

Steps to reproduce

1. Create a new project: vue create and choose to install support for SASS.
2. Install plugin: vue add buefy and select to add SCSS support.
3. The file located at
   src/assets/scss/.variables.scss should be named
   src/assets/scss/_variables.scss

What is expected?

Should have a file at the following location:
src/assets/scss/_variables.scss

What is actually happening?

The file is actually named:
src/assets/scss/.variables.scss

---

We believe the problem comes from

vue-cli/packages/@vue/cli/lib/GeneratorAPI.js

Line 139 in 05391b6

// dotfiles are ignored when published to npm, therefore in templates

where files starting with an _ are renamed to start with a . due to .files not included in npm uploads.

Files starting with an underscore are standard syntax for SCSS partials.

[Akryum]

@yyx990803 any suggestion for this?

[LinusBorg]

Well, we need a workaround like this to be able to work with dot-files in the generator. We can either change the "escape character" from _ to something else, like __ (2 underscores), or we can add another rule that says that files that should begin with an underscore should beginn with 2 underscores in templates, or something like this.

// either
__mydotfile > .mydotfile
_variables.scss > _variables

// or
_mydotfile > .mydotfile
__variables.scss > _variables

The latter would have the advantage that we can leave the previous behaviour for dotfiles untouched - it would only break dofiles that should also begin with an underscore.

[Akryum]

That would be:

_mydotfile > .mydotfile
__variables.scss > _variables.scss

[LinusBorg]

Right, thanks - fixed my post above.

The latter variant:

if (filename.charAt(0) === '_' && filename.chatAt(1) !== '_') {
  filename = `.${filename.slice(1)}`
}
if (filename.charAt(0) === '_' && filename.chatAt(1) === '_') {
  filename = `${filename.slice(1)}`
}

[SharpSeeEr]

Perfect. Thanks!