Skip to content

Commit 5b59fe0

Browse files
committed
docs: 'Style Guide' -> 'Code Conventions'
1 parent db03e0d commit 5b59fe0

File tree

9 files changed

+35
-35
lines changed

9 files changed

+35
-35
lines changed

README.md

+23-23
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Zillow JavaScript Style Guide() {
1+
# Zillow JavaScript Code Conventions() {
22

33
*A mostly reasonable approach to JavaScript*
44

@@ -7,7 +7,7 @@
77
[![npm version](https://img.shields.io/npm/v/eslint-config-zillow.svg)](https://www.npmjs.com/package/eslint-config-zillow)
88
[![Build Status](https://travis-ci.org/zillow/javascript.svg?branch=latest)](https://travis-ci.org/zillow/javascript)
99

10-
Other Style Guides
10+
Other Code Conventions:
1111

1212
- [React](react/)
1313
- [CSS-in-JavaScript](css-in-javascript/)
@@ -41,7 +41,7 @@ Other Style Guides
4141
1. [Events](#events)
4242
1. [jQuery](#jquery)
4343
1. [ECMAScript 5 Compatibility](#ecmascript-5-compatibility)
44-
1. [ECMAScript 6+ (ES 2015+) Styles](#ecmascript-6-es-2015-styles)
44+
1. [ECMAScript 6+ (ES 2015+) Patterns](#ecmascript-6-es-2015-patterns)
4545
1. [Standard Library](#standard-library)
4646
1. [Testing](#testing)
4747
1. [Performance](#performance)
@@ -1219,15 +1219,15 @@ Other Style Guides
12191219

12201220
```javascript
12211221
// bad
1222-
const ZillowStyleGuide = require('./ZillowStyleGuide');
1223-
module.exports = ZillowStyleGuide.es6;
1222+
const ZillowCodeConventions = require('./ZillowCodeConventions');
1223+
module.exports = ZillowCodeConventions.es6;
12241224
12251225
// ok
1226-
import ZillowStyleGuide from './ZillowStyleGuide';
1227-
export default ZillowStyleGuide.es6;
1226+
import ZillowCodeConventions from './ZillowCodeConventions';
1227+
export default ZillowCodeConventions.es6;
12281228
12291229
// best
1230-
import { es6 } from './ZillowStyleGuide';
1230+
import { es6 } from './ZillowCodeConventions';
12311231
export default es6;
12321232
```
12331233

@@ -1238,10 +1238,10 @@ Other Style Guides
12381238

12391239
```javascript
12401240
// bad
1241-
import * as ZillowStyleGuide from './ZillowStyleGuide';
1241+
import * as ZillowCodeConventions from './ZillowCodeConventions';
12421242
12431243
// good
1244-
import ZillowStyleGuide from './ZillowStyleGuide';
1244+
import ZillowCodeConventions from './ZillowCodeConventions';
12451245
```
12461246

12471247
<a name="modules--no-export-from-import"></a><a name="10.3"></a>
@@ -1252,11 +1252,11 @@ Other Style Guides
12521252
```javascript
12531253
// bad
12541254
// filename es6.js
1255-
export { es6 as default } from './ZillowStyleGuide';
1255+
export { es6 as default } from './ZillowCodeConventions';
12561256
12571257
// good
12581258
// filename es6.js
1259-
import { es6 } from './ZillowStyleGuide';
1259+
import { es6 } from './ZillowCodeConventions';
12601260
export default es6;
12611261
```
12621262

@@ -2412,22 +2412,22 @@ Other Style Guides
24122412

24132413
```javascript
24142414
// bad
2415-
import { es6 } from './ZillowStyleGuide';
2415+
import { es6 } from './ZillowCodeConventions';
24162416
// ...
24172417
export default es6;
24182418
```
24192419

24202420
```javascript
24212421
// bad
2422-
import { es6 } from './ZillowStyleGuide';
2422+
import { es6 } from './ZillowCodeConventions';
24232423
// ...
24242424
export default es6;↵
24252425
24262426
```
24272427

24282428
```javascript
24292429
// good
2430-
import { es6 } from './ZillowStyleGuide';
2430+
import { es6 } from './ZillowCodeConventions';
24312431
// ...
24322432
export default es6;↵
24332433
```
@@ -3085,12 +3085,12 @@ Other Style Guides
30853085
- [23.8](#naming--PascalCase-singleton) Use PascalCase when you export a constructor / class / singleton / function library / bare object.
30863086
30873087
```javascript
3088-
const ZillowStyleGuide = {
3088+
const ZillowCodeConventions = {
30893089
es6: {
30903090
},
30913091
};
30923092

3093-
export default ZillowStyleGuide;
3093+
export default ZillowCodeConventions;
30943094
```
30953095
30963096
<a name="naming--Acronyms-and-Initialisms"></a>
@@ -3345,11 +3345,11 @@ Other Style Guides
33453345

33463346
**[⬆ back to top](#table-of-contents)**
33473347

3348-
<a name="ecmascript-6-styles"></a>
3349-
## ECMAScript 6+ (ES 2015+) Styles
3348+
<a name="ecmascript-6-patterns"></a>
3349+
## ECMAScript 6+ (ES 2015+) Patterns
33503350

3351-
<a name="es6-styles"></a><a name="27.1"></a>
3352-
- [28.1](#es6-styles) This is a collection of links to the various ES6+ features.
3351+
<a name="es6-patterns"></a><a name="27.1"></a>
3352+
- [28.1](#es6-patterns) This is a collection of links to the various ES6+ features.
33533353

33543354
1. [Arrow Functions](#arrow-functions)
33553355
1. [Classes](#classes--constructors)
@@ -3468,13 +3468,13 @@ Other Style Guides
34683468
- [Prettier](https://prettier.io/)
34693469
- [Jest](https://facebook.github.io/jest/)
34703470

3471-
**Other Style Guides**
3471+
**Other Code Conventions**
34723472

34733473
- [Google JavaScript Style Guide](https://google.github.io/styleguide/javascriptguide.xml)
34743474
- [jQuery Core Style Guidelines](https://contribute.jquery.org/style-guide/js/)
34753475
- [Principles of Writing Consistent, Idiomatic JavaScript](https://github.com/rwaldron/idiomatic.js)
34763476

3477-
**Other Styles**
3477+
**Other Patterns**
34783478

34793479
- [Naming this in nested functions](https://gist.github.com/cjohansen/4135065) - Christian Johansen
34803480
- [Conditional Callbacks](https://github.com/airbnb/javascript/issues/52) - Ross Allen

css-in-javascript/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Zillow CSS-in-JavaScript Style Guide
1+
# Zillow CSS-in-JavaScript Code Conventions
22

33
*A mostly reasonable approach to CSS-in-JavaScript*
44

packages/babel-preset-zillow/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# `babel-preset-zillow`
22

3-
> A Babel preset for transpiling JavaScript following our styleguide
3+
> A Babel preset for transpiling JavaScript following our code conventions
44
55
Currently contains transforms for all standard syntax that is [stage 4](https://tc39.github.io/ecma262/) (ES2017) or [stage 3](https://github.com/tc39/proposals#active-proposals), except for the following:
66
- generators: `regenerator-runtime` is too heavyweight for our use.

packages/babel-preset-zillow/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
{
22
"name": "babel-preset-zillow",
33
"version": "1.0.0-alpha.1",
4-
"description": "A Babel preset for transpiling JavaScript following our styleguide",
4+
"description": "A Babel preset for transpiling JavaScript following our code conventions",
55
"keywords": [
66
"babel",
77
"es6",
8-
"es205",
8+
"es2015",
99
"javascript"
1010
],
1111
"author": "Daniel Stockman <[email protected]>",

packages/eslint-config-zillow-base/README.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33
[![npm version](https://img.shields.io/npm/v/eslint-config-zillow-base.svg)](https://www.npmjs.com/package/eslint-config-zillow-base)
44
[![Build Status](https://travis-ci.org/zillow/javascript.svg?branch=latest)](https://travis-ci.org/zillow/javascript)
55

6-
This package provides Zillow's base JS .eslintrc (without React plugins) as an extensible shared config.
6+
This package provides Zillow's base .eslintrc (without React plugins) as an extensible shared config.
77

88
## Usage
99

@@ -29,7 +29,7 @@ Our default export contains all of our ESLint rules, including ECMAScript 6+.
2929
## Related
3030

3131
- [Zillow's overarching ESLint config](https://npmjs.com/eslint-config-zillow)
32-
- [Zillow's Javascript styleguide](https://github.com/zillow/javascript)
32+
- [Zillow's Javascript code conventions](https://github.com/zillow/javascript)
3333

3434
## Development
3535

packages/eslint-config-zillow-base/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "eslint-config-zillow-base",
33
"version": "1.0.0-alpha.1",
4-
"description": "Zillow's base JS ESLint config, following our styleguide",
4+
"description": "Zillow's base ESLint config, following our code conventions",
55
"main": "index.js",
66
"files": [
77
"index.js",
@@ -20,7 +20,7 @@
2020
"config",
2121
"zillow",
2222
"javascript",
23-
"styleguide"
23+
"code conventions"
2424
],
2525
"author": "Daniel Stockman (https://twitter.com/@evocateur)",
2626
"license": "MIT",

packages/eslint-config-zillow/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,7 @@ If you don't need React, use [eslint-config-zillow-base](https://npmjs.com/eslin
3030

3131
## Related
3232

33-
- [Zillow's Javascript styleguide](https://github.com/zillow/javascript)
33+
- [Zillow's Javascript code conventions](https://github.com/zillow/javascript)
3434

3535
## Development
3636

packages/eslint-config-zillow/package.json

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
{
22
"name": "eslint-config-zillow",
33
"version": "1.0.0-alpha.1",
4-
"description": "Zillow's ESLint config, following our styleguide",
4+
"description": "Zillow's ESLint config, following our code conventions",
55
"main": "index.js",
66
"files": [
77
"index.js",
@@ -20,7 +20,7 @@
2020
"config",
2121
"zillow",
2222
"javascript",
23-
"styleguide"
23+
"code conventions"
2424
],
2525
"author": "Daniel Stockman (https://twitter.com/@evocateur)",
2626
"license": "MIT",

react/README.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Zillow React/JSX Style Guide
1+
# Zillow React/JSX Code Conventions
22

33
*A mostly reasonable approach to React and JSX*
44

0 commit comments

Comments
 (0)