Marmelator/pdf.js
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Updated Style Guide (markdown)

Tim van der Meij 2019-12-27 12:33:18 +01:00
parent cda85235a7
commit a819cc9f6e
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
Style-Guide.md

@ -1,6 +1,6 @@
This page outlines the style conventions that PDF.js follows to maintain a consistent codebase. We ask each contributor that creates a pull request to adhere to these conventions.
This page outlines the style conventions that PDF.js follows to maintain a consistent code base. We ask each contributor that creates a pull request to adhere to these conventions.
Many of these conventions will be checked automatically by a linter after each push to a branch of a pull request. Please refer to https://github.com/mozilla/pdf.js/wiki/Contributing#4-run-lint-and-testing for information about running the linter locally.
Most of these conventions ware checked automatically by a linter (Prettier) after each push to a branch of a pull request. Refer to https://github.com/mozilla/pdf.js/wiki/Contributing#4-run-lint-and-testing for information about running the linter locally.
## General
* Indentation: 2 spaces
@ -45,7 +45,7 @@ if (someVar === conditionA) {
Variables must be defined only once within a function scope, preferably at the top of the function. Use `const` if the value is not mutated and `let` if it is mutated. In new code we don't use `var` unless absolutely necessary.
## Classes
The standard way of creating classes in PDF.js used to be the following, so you might see this pattern in the current codebase. Please note that by class we mean an object that is class-like.
The standard way of creating classes in PDF.js used to be the following, so you might see this pattern in the current code base. Please note that by class we mean an object that is class-like.
```javascript
var ClassName = (function ClassNameClosure() {
@ -68,7 +68,7 @@ var ClassName = (function ClassNameClosure() {
})();
```
However, we are in the process of converting the codebase to ES6 syntax since classes are generally available in browsers and well optimized nowadays, so for new code we prefer the following way of creating classes.
However, we are in the process of converting our code to ES6 syntax since classes are generally available in browsers and well optimized nowadays, so for new code we prefer the following way of creating classes.
```javascript
class ClassName {