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
Add samples to Bower ignore #21
Comments
I don't think there's any problem with these files. They are not sent to the end user, so that would only save a few KBs on the server's disk and the downloaded directory would be slightly cleaner. On the other hand one may need the basic help contained in README or may want to check the change log. Since there's no strong reason we'll not touch anything now. We'll keep the issue opened though and if more developers will be interested in this change, then we'll do it. |
How hard is it to implement? I say if it is easy enough (sounds like it) then why not? |
It's trivial to implement. The question is - why should we change this? |
@Reinmar Because IDE's are not made for having such a large filebase. Let's say that your project depends on 10 libraries that all have 325 files, then it means that you have 3250 files in your IDE. Most IDE's like Aptana and Eclipse will have problems with these, because they attempt to run validations on them, scan the files, ..., causing the IDE to hang for several seconds. My current solution is to add a resource filter to ignore these folders, but that comes at a cost as well, since autocompletion (for example when adding the A second problem is, that if you're putting your project under version control, you don't want all these files to be versioned as well. So I would have to ignore them myself. The real problem (imo) is that if you have a dependency on a library, you only want to add the library itself to your project dependencies, not all the demos, documentation, info, readme's, ... . I mean, if you compare that to the Java world and Maven, then you will also only get the binaries you need, not the Javadocs, examples, ... . If you want those, you just visit the project webpage and download the source. |
I tried once loading CKEditor in some IDE and it crashed because CKEditor is 150k lines of JS code. Should I remove some files from my project? No, I should configure the IDE better, or use a better IDE, or a simpler code editor if such IDE does not exist. Then, you wrote yourself that 16% of the files in CKEditor package are samples. Will these 16% of HTML and MD files save your IDE? I don't think so. If something is a problem, then it's the JS files. Then, we've got users which will install CKEditor using Bower or Composer and won't find any help inside it. Next day we'll have a confused users which won't even file an issue, because most of them will be beginners or simply won't care. Additionally, we'll have to review all our docs looking for places where we said that there's a Last but not least, I agree with you. There should be less samples and documentation in the production package. And we are working on leaving just one simple HTML sample with an additional tool for toolbar configuration. All other samples will moved to so called CKEditor SDK. We hope to have it ready for CKEditor 4.5.0. |
I think several files including documentation/project info (README.md and CHANGES.md) and examples (samples/ directory) could be ignored when loading CKEditor by using Bower.
Currently, the standard package contains 325 files, while 16% of them are examples and Markdown files.
The text was updated successfully, but these errors were encountered: