Tooling
We allow developers to use the following Editors:-
However, it is imperative that whichever editor is used fully supports our automatic Linting and Styling rules. An example of this is Atom, which warns against improper styling in real-time as code is being written.
If you'd like to use something else, you might be able to but will need to get permission first. Just ask! 😄
We use NPM for almost every project. Some of our newer projects also use Yarn -- and if possible this should be used.
In rare cases, some of our older projects also use Bower modules.
Packages should only be added after careful consideration of the cost / benefit for that package, and whether or not the new package is necessary.
For example if the requirement is to make a single AJAX GET request, we should use HTML5's fetch() instead of adding in a Promise library such as Bluebird.
We should also pay close attention to our Dependency lists. Unless a package is explicitly required for the application to run (e.g. Express) it should go in the devDependencies list.
Occasionally it can be useful to work on multiple projects simultaneously. An example of this could be a site build and improvements to Kickoff React.
In situations like this, it is possible to link two projects together using either NPM or Yarn using the following commands:-
- in /Users/JP/Sites/kickoff-react
npm link
- then in /Users/JP/Sites/my-awesome-project
npm link kickoff-react
You only need to do this once. Under the hood, these commands will create a symlink to kickoff-react in your /node_modules directory, meaning it uses the local version of the package and not the version published on NPM.
You can then make changes to either project and see your changes reflected.