search

BladeRunnerJS / brjs

BladeRunnerJS (BRJS) is an open source development toolkit and framework for modular construction of large single-page HTML5 apps. It consists of a set of conventions, supporting tools and micro-libraries that make it easy to develop, test, deploy and maintain complex JavaScript apps.
http://bladerunnerjs.org/
GNU Lesser General Public License v3.0
229 stars 36 forks source link

Make our micro-libraries more like other Idiomatic JavaScript micro-libraries #1481

Closed dchambers closed 9 years ago

dchambers commented 9 years ago

Here's a list of improvements to bring us more in line with standard practice these days:

  1. Use karma, mocha & chai instead of jasmine for testing.
  2. Use browserify instead of webbuilder for building.
  3. Use eslint for linting.
  4. Use npm instead of Grunt as our build tool.
  5. Use standard directory names: lib -> src, spec -> test & target -> dist.
  6. Use npm test for running all tests, including a locally run browser test against Firefox, and SauceLab tests against various other browsers.
  7. Stop using jsdoc, and use example driven README.md based documentation only.
  8. Stop creating browser-modules compatible distributions of our libraries, that even we don't use.
  9. Use a master branch instead of a gh-pages branch for simplicity, and get rid of the extra styling, and links to the different presentations of the exact same content.
  10. Use : as a delimiter to indicate sub-tasks.
  11. Stop using browser detection guards within code and tests, and instead let browserify provide a consistent environment.
  12. Stop using Bower.

Additionally, we should provide a npm run test:browser:debug task that makes it easy for developers to debug the tests within a browser.

dchambers commented 9 years ago

This has now been done for emitr.

dchambers commented 9 years ago

Although things are now much simpler than they were before, the release process is still too complicated, so I've created #1490 to help with this.

dchambers commented 9 years ago

@andyberry88, you happy for this to be moved to ReadyForTest?

andy-berry-dev commented 9 years ago

:+1:

andy-berry-dev commented 9 years ago

@dchambers is there a PR that updates the mico-libraries to the latest versions?

dchambers commented 9 years ago

@andyberry88, no, I just went ahead and made the changes in the master branches of the various projects. This is actually what we've always done, where the QA effort is used to confirm that it's safe to consume the changes within BRJS.

This is clearly not the right way of doing things, but is probably a consequence of the fact that it's not easy to manage sprints that involve multiple projects.

andy-berry-dev commented 9 years ago

@dchambers We need a PR in BRJS to update each library to the latest version. Otherwise we just have a series of microlibraries that have changed but we're not making use of those changes in BRJS.

dchambers commented 9 years ago

Here are the relevant commits:

all of which are long since merged into master.