Add vendor directories, exclude them from linting

[arturkot]

Hi everyone,

the purpose of this PR is to provide a way to easily add third party dependencies which, for various reasons, can't be installed from NPM. It usually applies to jQuery plugins or paid scripts which can't be exposed to all users. Same can go for CSS files.

Please let me know your thoughts!

Should (and can) I add any tests for this update? I'd need some directions here. :)

Cheers,

Artur

[luboskmetko]

I'm wondering if it wouldn't be more reliable and flexible to use .eslintignore and .stylelintignore files with node_modules and vendor folders added to them by default. Then we or developers can easily add additional files and folders if needed.

[jakub300]

How should we use scripts/styles from vendor directories?

[arturkot]

@luboskmetko Pushed! It works fine Mac OS. Would be cool to test those ignore files in Windows and Linux as well.

@jakub300

How should we use scripts/styles from vendor directories?

By using browserify-shim I think as Browserify is installed by default. Kind of like regular NPM packages. That's the most popular way (and problematic at the same time!) to add scripts judging on the dev help channel. :)

[luboskmetko]

hey @arturkot can you please use only vendor instead of src/scripts/vendor and src/styles/vendor? In WP projects there is an option to move the src folder to the theme folder and I don't think the path would work then. Thanks

[jakub300]

Hey @arturkot,
If JS vendor directory is supposed to be used with browserify-shim could you write a proper guide how to use browserify-shim? It doesn't have to be part of that PR but it should finally happen.

Regarding this PR please verify what happens when src directory is moved to different place (there is option when creating WP project to do that).

[luboskmetko]

@jakub300 @arturkot I've tested this when src moved to a different place, it works when you just use vendor folder instead of the whole path.

Agree regarding browserify-shim, but there is already an issue for that here #173

[arturkot]

@jakub300 I'll add creating a guide to my to-do list. Thanks for pointing that out!

[arturkot]

@luboskmetko Done!

Just need to point out one thing I've noticed. When I choose to move src into the theme directory (during yo setup), gulp build fails. Seems like the src in theme was incomplete (only some styles were copied). Manually copy-pasting the src from root into the theme fixed the issue.

I guess it's resolved in another PR?

Here's my yo config:

{
  "generator-chisel": {
    "config": {
      "name": "Some Random WP project",
      "author": "Artur",
      "projectType": "wp-with-fe",
      "nameSlug": "some-random-wp-project",
      "nameCamel": "Somerandomwpproject",
      "features": {
        "has_jquery": true,
        "has_babel": true
      }
    }
  }
}

Screenshot from terminal:

Theme's src:

cc @jakub300

[arturkot]

@luboskmetko @jakub300 Please disregard the above comment. Sorry! Michal reminded me to rebase the branch which, of course, resolved the problem.