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.

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

Review the raw-loader dependency version in the project documentation #1420

Closed
oleq opened this issue Dec 18, 2018 · 3 comments · Fixed by #1422
Closed

Review the raw-loader dependency version in the project documentation #1420

oleq opened this issue Dec 18, 2018 · 3 comments · Fixed by #1422
Assignees
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide). type:task This issue reports a chore (non-production change) and other types of "todos".
Milestone

Comments

@oleq
Copy link
Member

oleq commented Dec 18, 2018

We had a bug report concerning installing the editor with the Vue CLI from source (plenty of errors).

As it turned out the culprit was the raw-loader dependency, which has been updated to v1.0.0 a week ago by the maintainers (our project uses v0.5.1).

I updated the Vue.js feature guide so it tells the users to install raw-loader@0.5.1 but I also noticed that there are other guides that require installing raw-loader from npm and, in theory, they all could suffer from the same bug:

ckeditor5/docs/builds/guides/frameworks/react.md
ckeditor5/docs/builds/guides/frameworks/vuejs.md
ckeditor5/docs/builds/guides/integration/advanced-setup.md
ckeditor5/docs/framework/guides/quick-start.md

Things to do:

  • Check if this is actually an issue for these guides if people install 1.0.0 instead of 0.5.x (I'm pretty sure it is),
  • If so, update the guides replacing raw-loader with raw-loader@0.5.1.
  • Alternatively, we could figure out what's wrong with v1.0.0 and update our configs instead, effectively migrating the project to the latest raw-loader.
@oleq oleq added status:confirmed type:task This issue reports a chore (non-production change) and other types of "todos". type:docs This issue reports a task related to documentation (e.g. an idea for a guide). labels Dec 18, 2018
@oleq oleq added this to the iteration 22 milestone Dec 18, 2018
@jodator jodator assigned jodator and unassigned ma2ciek Dec 18, 2018
@jodator
Copy link
Contributor

jodator commented Dec 18, 2018

I'l update the docs as there are few minor issues:

  1. I think the SVG part is not correct on how to use raw-loader:

    chainWebpack: config => {
    	// Vue CLI would normally use its own loader to load .svg files. The icons used by
    	// CKEditor should be loaded using raw-loader instead.
    	config.module
    		.rule( 'svg' )
    		.test( /ckeditor5-[^/\\]+[/\\]theme[/\\]icons[/\\][^/\\]+\.svg$/ )
    		.use( 'file-loader' )
    		.loader( 'raw-loader' );
    }

    Should at least .use( 'raw-loader' ) (not file-loader) and then chain .loader( 'raw-loader' ) - that was causing the wrong config object error.

  2. Remove (or use better .test() ) the Vue's base loader for SVG. The base loader is used instead of the one from docs and just replaces SVG file's path.

@oleq
Copy link
Member Author

oleq commented Dec 19, 2018

@jodator But what's the actual conclusion?

Is it OK that we recommend npm install raw-loader and it comes as v1.0.0?

Or should we state there that npm install raw-loader@0.5.1 is required?

@jodator
Copy link
Contributor

jodator commented Dec 19, 2018

Still testing

oleq added a commit that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0. Updated the Vue.js component guide. Closes #1420.
oleq added a commit to ckeditor/ckeditor5-dev that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
oleq added a commit to ckeditor/ckeditor5-build-inline that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
oleq added a commit to ckeditor/ckeditor5-build-classic that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
oleq added a commit to ckeditor/ckeditor5-build-decoupled-document that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
oleq added a commit to ckeditor/ckeditor5-build-balloon that referenced this issue Dec 19, 2018
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
JDinABox pushed a commit to JDinABox/ckeditor5-build-markdown that referenced this issue Sep 6, 2021
Internal: Updated the `raw-loader` dependency to 1.0.0 (see ckeditor/ckeditor5#1420).
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
type:docs This issue reports a task related to documentation (e.g. an idea for a guide). type:task This issue reports a chore (non-production change) and other types of "todos".
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants