Fix using colon in the filename on Windows #506

aminya · 2020-07-23T23:56:43Z

Rollup Plugin Name: `multi-entry`

This PR contains:

Are tests included?

yes: I included the real-world tests.

Previously the tests were using getCode which is not what happens in the real world. This fixes an already broken plugin on Windows. To see the difference, you need proper Windows machine or Windows support in Repl.it to run the tests before and after.

no:

Breaking Changes?

yes (breaking changes will not be merged unless absolutely necessary)
no

List any relevant issue numbers:
Fixes #488

Description

use U+A789 instead of colon in the file name on Windows

frank-dspeed · 2020-07-24T05:27:43Z

@shellscape @lukastaegert can you please review this it is the fix for the windows : char not supported issue of plugin multi entry

#488 (comment)

shellscape · 2020-07-24T11:13:24Z

Patience, please. This PR is less than 24 hours old.

shellscape · 2020-07-25T02:05:39Z

packages/multi-entry/src/index.js

+let entry;
+if (process.platform === "win32") {
+  // the colon is different
+	entry = '\0rollup꞉plugin-multi-entry꞉entry-point';


this is an interesting hack (great thinking). @lukastaegert can you see a situation in which this would cause problems? if not, we should just unify on that unicode character for all platforms.

@shellscape i am not sure how linux handels that unicode char at last inside bash i could expect that copy paste of that file name will result into not opening the file but it needs testing i never used such chars on linux filesystems before i think it is clever to do this only for windows so that nothing else breaks that already works.

@shellscape i see a problem with the process.platform variable used inside browser should be no global process at last.But in general a if condition is the way to go so we break not as much.

The name of the final bundle is now _rollup꞉plugin-multi-entry꞉entry-point.js. Is this the desired behavior?

My question is why you don't give an option to the user for choosing the name?

Ok, really stupid question, but there is no reason at all to have those colons, and using a clever character substitution that will even depend on the system running it does not feel like a good idea. So why not just a new name? And while we are at it considering that this is becomes a real file name when using the dir, why not just entry.js or index.js? I also think that there is no reason at all to use the \0 prefix, on the contrary, it could be beneficial if a user could run Babel transforms on that file. And in the long run, it might make sense to make the actual name a config option of this plugin for the case when the dir option is used.

We would also need a test for that case and the new option, as well as a test using the dir option without specifying the entry name.

This is just a patch. I'd say let's merge this as it is to fix the issue temporarily. In a separate pull request, we can make a feat to add options. However, we should not put this patch on hold for that.

@aminya I suggest using another clean name like rollup_plugin_multi_entry_entry_point

Yes, that would be my requirement as well. If you think that would be breaking, then your patch would be breaking as well as it changes the name on Windows. But worse, it will make the windows build differ from what is generated on other systems.
In any case, even if the option is not added, a single test using the dir option would still be important.

@aminya I suggest using another clean name like rollup_plugin_multi_entry_entry_point

Please no. That's damn ugly.

frank-dspeed · 2020-07-28T10:39:09Z

i have looked into this and i will make the output filename configure able i have looked what it does and it was made befor the dir option existed.

cyclops24 · 2020-07-28T12:56:11Z

@aminya @lukastaegert @frank-dspeed Guys, I didn't understand Why do we want to complicate matters? I think just a simple file name change from \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point is enough. Why we need a parameter for configuring that or using a special character like U+A789 to keep this messy : in the file name. Why we need this : or parameter? 🤔

also make this configurable is another problem and it's a new feature why we need mixing that feature request with this issue?
We now just need a fix PR to change \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point. I can create once if you want.

frank-dspeed · 2020-07-28T14:06:32Z

@cyclops24 ok i will explain it to you

the plugin generates a virtual entrypoint a file that does not exist and imports the other files inside that

then it wants to write that file but it has no name so this virtual ...... name gets used the option is needed to supply a usefull filename for the output set able by the user.for dynamic imports the normal chunkFileName Patterns get used.

I hope you understand that now more well.

at present plugin-virtual is a drop in replacement for this when u use glob to set the content of the virtual module.

cyclops24 · 2020-07-28T14:29:11Z

@frank-dspeed Thanks for your description. 🌹 It was as I imagined.
Just one question:
So the : character in the filename is important for this plugin-virtual?
Have we any convention about this?
You mean if we change \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point for fix this issue then we breaks plugin-virtual or other things?

My suggestion is clear:
Change \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point as a fix for this issue and close #488 and then make new PR to add a parameter to customize this file name.

frank-dspeed · 2020-07-28T15:58:33Z

@cyclops24 you can change it and your done simply copy the content of the plugin into your config and change that to what ever filename you want it will work. but rollup will need to solve it via a option.

shellscape · 2020-07-29T15:43:31Z

Change \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point as a fix for this issue and close #488 and then make new PR to add a parameter to customize this file name.

I will block this suggestion. If we're going to fix this, we fix it right. I'm not going to approve a half measure just to close an issue.

shellscape

You should have the tests already. This fixes an already broken plugin on Windows. To see the difference, you need proper Windows CI or a Windows support in Repl.it. If you had the Windows tests in the first place, this would have not happened.

No, this is not correct. If you examine the checks you'll see that we have two workflows through Github Actions that run on windows. This PR will not be merged until the proper tests are added. You can use os.platform to add platform-specific tests.

cyclops24 · 2020-07-29T15:58:15Z

Change \0rollup:plugin-multi-entry:entry-point to rollup_plugin_multi_entry_entry_point as a fix for this issue and close #488 and then make new PR to add a parameter to customize this file name.

I will block this suggestion. If we're going to fix this, we fix it right. I'm not going to approve a half measure just to close an issue.

As I told before you have combined the fix and the new feature. This is a fix PR. So we don't need to add a new parameter to configure the output file name in this PR.
The output filename parameter is a new feature and needs a separate feature PR.
But anyway if you prefer to keep this known bug and tie this to that new feature, do it. It was just my suggestion 😉

shellscape · 2020-07-29T16:03:54Z

This is a fix PR. So we don't need to add a new parameter to configure the output file name in this PR. The output filename parameter is a new feature and needs a separate feature PR.

We have multiple options in the pull request template that are not mutually exclusive. Our PRs can be one or many of: bugfix, feature, refactor, documentation, or other. Your suggestion is noted and appreciated, but as a maintainer of the repo I have chosen to reject the suggestion as a half-measure.

aminya · 2020-07-29T17:32:07Z

I fixed the tests of multi-entry plugin. This is more ready to get merged.

frank-dspeed · 2020-07-30T05:27:54Z

Only to make this complet we can replace this multi entry by @rollup/plugin-virtual

import virtual from '@rollup/plugin-virtual';
import { promise as matched } from 'matched';

let entry = 'filename'
let include = [];
let exclude = [];

/* You can choose if you want to import only or export  */
let prefix = 'export * from' // 'import'
let exporter = (path) => `${prefix} ${JSON.stringify(path)};`;
const patterns = include.concat(exclude.map((pattern) => `!${pattern}`));

const entrys = matched(patterns, { realpath: true }).then((paths) =>
    paths.map(exporter).join('\n')
);

export default {
  input: entry,
  // ...
  plugins: [
    virtual({ [entry]: entrys })
  ]
};

my current version of this plugin

import { promise as matched } from 'matched';

export default function multiEntry(conf={}) {
   const config = { 
    include: [],
    exclude: [],
    exports: true,
    outputFile: 'multi-entry',
    ...conf
  }
  let { outputFile, include, exclude, exports } = config;
  if (include.length === 0) {
      // We need any includes
      throw new Error('We need Include and a outputFile')
  }
  if (typeof include === 'string' || typeof include === 'array'){
      new Error('type of include needs to be string or array of strins')
  }
  
  if (typeof exclude === 'string' || typeof exclude === 'array'){
    new Error('type of exclude needs to be string or array of strins')
  }

  //String option to array
  if (typeof exclude === 'string') {
    exclude = [exclude]
  }   
  if (typeof include === 'string') {
    include = [exclude]
  }   

  let prefix = exports ? 'export * from' : 'import'
  let exporter = (path) => `${prefix} ${JSON.stringify(path)};`;

  return {
    buildStart() {
       this.emitFile({ type: 'chunk', id: outputFile })
    },
    resolveId(id) {
      return id === outputFile ? id : null;
    },
    load(id) {
      if (id === outputFile) {
        const patterns = include.concat(exclude.map((pattern) => `!${pattern}`));
        return matched(patterns, { realpath: true })
            .then(paths => paths.map(exporter).join('\n'));
      }
      return null
    }
  };
}

Bluefinger · 2020-07-30T06:16:23Z

@frank-dspeed As a note regarding your code example, there's no such thing as 'array' for typeof. Arrays are 'object' type 😄 so you'd want to ensure the checks use Array.isArray. Plus your type guard checks need to be inverted, so typeof include !== 'string'. Anyway, a bit off topic so I'mma just go back to keeping an eye on this PR.

frank-dspeed · 2020-07-30T06:36:43Z

@Bluefinger good catches it was only to demo the algo any way so pick up the code that you like and issue a PR that would help the people i am at present working on a diffrent front i want to get ESM interop fixed everywhere so i am kinda busy.

i vote strong for reuse of plugin-virtual it would be a good example and reciepe for others.

It would be clever to create a new clean PR with a good version @Bluefinger

aminya · 2020-07-31T18:20:39Z

This is rebased to fix the conflicts caused by #513. This is ready from my side.

shellscape

I agree with the reply: https://github.com/rollup/plugins/pull/506/files#r461395228 that this should be made configurable and that an option is the proper fix (even though it is a new feature, technically). I stand by my reply: #506 (comment).

We'll have to wait for this to be made configurable before approving this PR. Please avoid additional discussion about this decision, replies doing so will be hidden as off-topic.

Update: I just ran across #520. It may supersede this PR, but can't say for certain until we get eyes on it.

aminya force-pushed the windows_multientry branch 3 times, most recently from 4bacea4 to 88efc37 Compare July 24, 2020 00:06

aminya marked this pull request as draft July 24, 2020 00:10

aminya changed the title ~~use U+A789 instead of colon in the file name on Windows~~ Fix using colon in the filename on Windows Jul 24, 2020

aminya marked this pull request as ready for review July 24, 2020 00:12

shellscape reviewed Jul 25, 2020

View reviewed changes

aminya mentioned this pull request Jul 28, 2020

Rollup bus-stop/x-terminal#109

Closed

shellscape added pr⁴ 🔧 fix 🔌 plugin-multi-entry labels Jul 29, 2020

shellscape requested changes Jul 29, 2020

View reviewed changes

aminya requested a review from shellscape July 29, 2020 17:26

aminya requested a review from lukastaegert July 29, 2020 20:38

aminya added 3 commits July 31, 2020 13:14

fix: use U+A789 instead of colon on Windows

9fc1ebe

fix: real test for multi-entry bundle.write

941ca10

fix: use del to delete files

7431f4e

chore: update pnpm lock

669f29b

aminya force-pushed the windows_multientry branch from 8583e92 to 669f29b Compare July 31, 2020 18:20

Bluefinger mentioned this pull request Jul 31, 2020

refactor(multi-entry): virtualised & entryFileName #520

Merged

9 tasks

shellscape requested changes Aug 1, 2020

View reviewed changes

aminya closed this Aug 1, 2020

This comment has been minimized.

Sign in to view

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Fix using colon in the filename on Windows #506

Fix using colon in the filename on Windows #506

aminya commented Jul 23, 2020 •

edited

Loading

frank-dspeed commented Jul 24, 2020

shellscape commented Jul 24, 2020

shellscape Jul 25, 2020

frank-dspeed Jul 25, 2020

frank-dspeed Jul 25, 2020

aminya Jul 25, 2020

lukastaegert Jul 25, 2020

lukastaegert Jul 28, 2020

aminya Jul 28, 2020 •

edited

Loading

cyclops24 Jul 28, 2020

lukastaegert Jul 28, 2020

shellscape Jul 29, 2020

frank-dspeed commented Jul 28, 2020

cyclops24 commented Jul 28, 2020 •

edited

Loading

frank-dspeed commented Jul 28, 2020 •

edited

Loading

cyclops24 commented Jul 28, 2020 •

edited

Loading

frank-dspeed commented Jul 28, 2020

shellscape commented Jul 29, 2020

shellscape left a comment •

edited

Loading

cyclops24 commented Jul 29, 2020 •

edited

Loading

shellscape commented Jul 29, 2020 •

edited

Loading

aminya commented Jul 29, 2020 •

edited

Loading

frank-dspeed commented Jul 30, 2020 •

edited

Loading

Bluefinger commented Jul 30, 2020

frank-dspeed commented Jul 30, 2020 •

edited

Loading

aminya commented Jul 31, 2020

shellscape left a comment •

edited

Loading

This comment has been minimized.

Fix using colon in the filename on Windows #506

Fix using colon in the filename on Windows #506

Conversation

aminya commented Jul 23, 2020 • edited Loading

Rollup Plugin Name: multi-entry

Description

frank-dspeed commented Jul 24, 2020

shellscape commented Jul 24, 2020

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

aminya Jul 28, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

frank-dspeed commented Jul 28, 2020

cyclops24 commented Jul 28, 2020 • edited Loading

frank-dspeed commented Jul 28, 2020 • edited Loading

cyclops24 commented Jul 28, 2020 • edited Loading

frank-dspeed commented Jul 28, 2020

shellscape commented Jul 29, 2020

shellscape left a comment • edited Loading

Choose a reason for hiding this comment

cyclops24 commented Jul 29, 2020 • edited Loading

shellscape commented Jul 29, 2020 • edited Loading

aminya commented Jul 29, 2020 • edited Loading

frank-dspeed commented Jul 30, 2020 • edited Loading

Bluefinger commented Jul 30, 2020

frank-dspeed commented Jul 30, 2020 • edited Loading

aminya commented Jul 31, 2020

shellscape left a comment • edited Loading

Choose a reason for hiding this comment

This comment has been minimized.

aminya commented Jul 23, 2020 •

edited

Loading

Rollup Plugin Name: `multi-entry`

aminya Jul 28, 2020 •

edited

Loading

cyclops24 commented Jul 28, 2020 •

edited

Loading

frank-dspeed commented Jul 28, 2020 •

edited

Loading

cyclops24 commented Jul 28, 2020 •

edited

Loading

shellscape left a comment •

edited

Loading

cyclops24 commented Jul 29, 2020 •

edited

Loading

shellscape commented Jul 29, 2020 •

edited

Loading

aminya commented Jul 29, 2020 •

edited

Loading

frank-dspeed commented Jul 30, 2020 •

edited

Loading

frank-dspeed commented Jul 30, 2020 •

edited

Loading

shellscape left a comment •

edited

Loading