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

Proposal: Code Standards #223

Closed
jniles opened this issue Mar 27, 2016 · 3 comments
Closed

Proposal: Code Standards #223

jniles opened this issue Mar 27, 2016 · 3 comments

Comments

@jniles
Copy link
Collaborator

jniles commented Mar 27, 2016

Motivation
With the recent styleguides and discussion around contributions, I propose that we adopt an official, immutable styleguide. We will enforce this styleguide in our lint checks, and it will be equivalent to tests in terms of blocking/allowing pull requests.

Proposal
I propose we switch from the inflexible jshint to the much more flexible ESLint. ESLint allows users to write custom plugins which makes it easy to encode a styleguide into the lint checks.

I propose we use AirBnB's styleguide. The benefits I see are the following:

  1. modern - it is updated frequently and built with the future of javascript in mind
  2. automatic lint checks - if we choose AirBnB's styleguide + eslint, we can automatically check that code is compliant with an eslint plugin.
  3. respected - a lot of projects use it.

I think these standards will help settle a lot of discussions about code standards.

@IMA-WorldHealth/local-contributors, what do you think? Are there any alternative proposals for styleguides?

Also of interest, here is an ES6 compatibility table.

@jniles
Copy link
Collaborator Author

jniles commented Dec 16, 2016

This winter break seems like a really good time to roll out these standards. Node 6 is the current LTS release with ES6 support, and our application is fairly stable.

There are a lot of cool rules that would help me write code better in ESLint! Here is the full list.

I'll look into implementing this in the coming weeks.

@jniles jniles self-assigned this Dec 16, 2016
@jniles jniles added this to the Future milestone Dec 16, 2016
@mbayopanda
Copy link
Contributor

mbayopanda commented Dec 17, 2016 via email

jniles referenced this issue in jniles/bhima Jan 31, 2017
This commit tries to end all the protractor errors with the journal by
ensuring it sleeps when the column change is fired.

Closes #223.
@sfount sfount closed this as completed in 3bb45d0 Feb 6, 2017
@jniles
Copy link
Collaborator Author

jniles commented Feb 6, 2017

This wasn't actually supposed to be closed. My mistake!

@jniles jniles reopened this Feb 6, 2017
jniles referenced this issue in jniles/bhima Feb 13, 2017
This commit removes our dependency on jshint and replaces it with eslint
as a linter.  Eslint is much stricter and will reduce the work of a code
reviewer in commenting on style.  The current codebase will need to be
migrated significantly and rulesets customized for this to be an
effective tool.

Closes #223.
sfount pushed a commit that referenced this issue Feb 14, 2017
This commit removes our dependency on jshint and replaces it with eslint
as a linter.  Eslint is much stricter and will reduce the work of a code
reviewer in commenting on style.  The current codebase will need to be
migrated significantly and rulesets customized for this to be an
effective tool.

Closes #223.
bors bot added a commit that referenced this issue Oct 3, 2018
3220: Update snyk to the latest version 🚀 r=jniles a=greenkeeper[bot]


## The dependency [snyk](https://github.com/snyk/snyk) was updated from `1.99.1` to `1.100.0`.
This version is **not covered** by your **current version range**.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.

---

<details>
<summary>Release Notes for v1.100.0</summary>

<h1><a href="https://urls.greenkeeper.io/snyk/snyk/compare/v1.99.1...v1.100.0">1.100.0</a> (2018-10-03)</h1>
<h3>Features</h3>
<ul>
<li>Bump resolve-deps to latest (<a href="https://urls.greenkeeper.io/snyk/snyk/commit/72df523">72df523</a>)</li>
</ul>
</details>

<details>
<summary>Commits</summary>
<p>The new version differs by 4 commits.</p>
<ul>
<li><a href="https://urls.greenkeeper.io/snyk/snyk/commit/ddf13eef1d48260c00e0973b0daa024c41f2daab"><code>ddf13ee</code></a> <code>Merge pull request #229 from snyk/feat/bump-resolve-deps</code></li>
<li><a href="https://urls.greenkeeper.io/snyk/snyk/commit/72df523389cf66941ba69a836f255ac91d06104f"><code>72df523</code></a> <code>feat: Bump resolve-deps to latest</code></li>
<li><a href="https://urls.greenkeeper.io/snyk/snyk/commit/3af11b80f3a204d1507053c226440a0469cfeec3"><code>3af11b8</code></a> <code>Merge pull request #223 from snyk/chore/remove-package-lock</code></li>
<li><a href="https://urls.greenkeeper.io/snyk/snyk/commit/6713708674fc8fbd8077da1056f7dd8db61ccd0f"><code>6713708</code></a> <code>chore: remove package-lock and ignore it</code></li>
</ul>
<p>See the <a href="https://urls.greenkeeper.io/snyk/snyk/compare/479260b133d5d7ea3a92ea8d666def360b5ef36f...ddf13eef1d48260c00e0973b0daa024c41f2daab">full diff</a></p>
</details>

<details>
  <summary>FAQ and help</summary>

  There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).
</details>

---


Your [Greenkeeper](https://greenkeeper.io) bot 🌴



Co-authored-by: greenkeeper[bot] <greenkeeper[bot]@users.noreply.github.com>
bors bot added a commit that referenced this issue Jan 26, 2020
4128: Update cross-env to the latest version 🚀 r=jniles a=greenkeeper[bot]


## The dependency [cross-env](https://github.com/kentcdodds/cross-env) was updated from `6.0.3` to `7.0.0`.
This version is **not covered** by your **current version range**.

If you don’t accept this pull request, your project will work just like it did before. However, you might be missing out on a bunch of new features, fixes and/or performance improvements from the dependency update.

---

**Publisher:** [kentcdodds](https://www.npmjs.com/~kentcdodds)
**License:** MIT

<details>
<summary>Release Notes for v7.0.0</summary>

<h1><a href="https://urls.greenkeeper.io/kentcdodds/cross-env/compare/v6.0.3...v7.0.0">7.0.0</a> (2020-01-25)</h1>
<h3>Features</h3>
<ul>
<li>update dependencies (<a href="https://urls.greenkeeper.io/kentcdodds/cross-env/issues/223" data-hovercard-type="pull_request" data-hovercard-url="/kentcdodds/cross-env/pull/223/hovercard">#223</a>) (<a href="https://urls.greenkeeper.io/kentcdodds/cross-env/commit/4ec6f4009d05c571d1737306cb787499d511048b">4ec6f40</a>)</li>
</ul>
<h3>BREAKING CHANGES</h3>
<ul>
<li>Drop Node 8 support</li>
</ul>
</details>

<details>
<summary>Commits</summary>
<p>The new version differs by 1 commits.</p>
<ul>
<li><a href="https://urls.greenkeeper.io/kentcdodds/cross-env/commit/4ec6f4009d05c571d1737306cb787499d511048b"><code>4ec6f40</code></a> <code>feat: update dependencies (#223)</code></li>
</ul>
<p>See the <a href="https://urls.greenkeeper.io/kentcdodds/cross-env/compare/67f21c32543af0ecdbaf2508d620d81d3307a433...4ec6f4009d05c571d1737306cb787499d511048b">full diff</a></p>
</details>

---

<details>
  <summary>FAQ and help</summary>

  There is a collection of [frequently asked questions](https://greenkeeper.io/faq.html). If those don’t help, you can always [ask the humans behind Greenkeeper](https://github.com/greenkeeperio/greenkeeper/issues/new).
</details>

---


Your [Greenkeeper](https://greenkeeper.io) bot 🌴



Co-authored-by: greenkeeper[bot] <23040076+greenkeeper[bot]@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants