Skip to content

Commit 693b3e7

Browse files
Merge pull request #10 from RobotlegsJS/prettier
Enable Prettier
2 parents 37dd4ea + 563c57a commit 693b3e7

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

51 files changed

+567
-377
lines changed

.prettierrc

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,9 @@
1+
{
2+
"printWidth": 80,
3+
"tabWidth": 4,
4+
"useTabs": false,
5+
"semi": true,
6+
"singleQuote": false,
7+
"trailingComma": "none",
8+
"bracketSpacing": true
9+
}

README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ SignalsJS
77
[![Test Coverage](https://codeclimate.com/github/RobotlegsJS/SignalsJS/badges/coverage.svg)](https://codeclimate.com/github/RobotlegsJS/SignalsJS/coverage)
88
[![npm version](https://badge.fury.io/js/%40robotlegsjs%2Fsignals.svg)](https://badge.fury.io/js/%40robotlegsjs%2Fsignals)
99
[![Greenkeeper badge](https://badges.greenkeeper.io/RobotlegsJS/SignalsJS.svg)](https://greenkeeper.io/)
10+
[![styled with prettier](https://img.shields.io/badge/styled_with-prettier-ff69b4.svg)](https://github.com/prettier/prettier)
1011

1112
TypeScript port of [AS3 Signals](https://github.com/robertpenner/as3-signals).
1213
[13kb compressed](dist/signals.min.js).

package.json

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,8 @@
77
"scripts": {
88
"test": "nyc mocha",
99
"karma": "karma start --single-run",
10-
"autoformat": "tsfmt -r --useTsconfig tsconfig.test.json",
10+
"autoformat": "prettier --config .prettierrc --write {src,test}/**/{*,*.test}.ts",
11+
"tslint-check": "tslint-config-prettier-check ./tslint.json",
1112
"prepublish": "tsc -d && publish-please guard",
1213
"clean-up": "rm -rf coverage && rm -rf lib",
1314
"publish-please": "npm run autoformat && npm run clean-up && npm run build && publish-please",
@@ -85,6 +86,7 @@
8586
"karma-webpack": "^2.0.4",
8687
"mocha": "^3.5.0",
8788
"nyc": "^11.1.0",
89+
"prettier": "^1.6.1",
8890
"publish-please": "^2.3.1",
8991
"reflect-metadata": "^0.1.10",
9092
"remap-istanbul": "^0.9.5",
@@ -95,8 +97,8 @@
9597
"ts-loader": "^2.3.4",
9698
"ts-node": "^3.3.0",
9799
"tslint": "^5.7.0",
100+
"tslint-config-prettier": "^1.5.0",
98101
"typescript": "^2.5.2",
99-
"typescript-formatter": "^6.0.0",
100102
"webpack": "^3.5.5",
101103
"webpack-dev-server": "^2.7.1"
102104
}

src/index.ts

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
export { DeluxeSignal } from "./org/osflash/signals/DeluxeSignal";
22
export { GenericEvent } from "./org/osflash/signals/events/GenericEvent";
3-
export { IBubbleEventHandler } from "./org/osflash/signals/events/IBubbleEventHandler";
3+
export {
4+
IBubbleEventHandler
5+
} from "./org/osflash/signals/events/IBubbleEventHandler";
46
export { IEvent } from "./org/osflash/signals/events/IEvent";
57
export { IOnceSignal } from "./org/osflash/signals/IOnceSignal";
68
export { IPrioritySignal } from "./org/osflash/signals/IPrioritySignal";

src/org/osflash/signals/DeluxeSignal.ts

Lines changed: 19 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,10 @@ export class DeluxeSignal extends PrioritySignal {
3535
*/
3636
constructor(target: Object = null, ...valueClasses) {
3737
// Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
38-
valueClasses = (valueClasses.length === 1 && valueClasses[0] instanceof Array) ? valueClasses[0] : valueClasses;
38+
valueClasses =
39+
valueClasses.length === 1 && valueClasses[0] instanceof Array
40+
? valueClasses[0]
41+
: valueClasses;
3942

4043
super(valueClasses);
4144

@@ -71,26 +74,35 @@ export class DeluxeSignal extends PrioritySignal {
7174
if (numValueObjects < numValueClasses) {
7275
throw new Error(
7376
"Incorrect number of arguments. " +
74-
"Expected at least " + numValueClasses + " but received " +
75-
numValueObjects + "."
77+
"Expected at least " +
78+
numValueClasses +
79+
" but received " +
80+
numValueObjects +
81+
"."
7682
);
7783
}
7884

7985
// Cannot dispatch differently typed objects than declared classes.
8086
for (let i: number = 0; i < numValueClasses; i++) {
8187
// Optimized for the optimistic case that values are correct.
82-
if (valueObjects[i] === null || valueObjects[i].constructor === this._valueClasses[i]) {
88+
if (
89+
valueObjects[i] === null ||
90+
valueObjects[i].constructor === this._valueClasses[i]
91+
) {
8392
continue;
8493
}
8594

8695
throw new Error(
87-
"Value object <" + valueObjects[i] +
88-
"> is not an instance of <" + this._valueClasses[i] + ">."
96+
"Value object <" +
97+
valueObjects[i] +
98+
"> is not an instance of <" +
99+
this._valueClasses[i] +
100+
">."
89101
);
90102
}
91103

92104
// Extract and clone event object if necessary.
93-
let event: IEvent = (<IEvent>valueObjects[0]);
105+
let event: IEvent = <IEvent>valueObjects[0];
94106
if (event) {
95107
if (event.target) {
96108
event = event.clone();

src/org/osflash/signals/IOnceSignal.ts

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,9 +9,10 @@ export interface IOnceSignal {
99
* An optional array of classes defining the types of parameters sent to listeners.
1010
*/
1111
valueClasses: any[];
12-
/*function set valueClasses(value:Array):void;*/
1312

14-
/** The current number of listeners for the signal. */
13+
/**
14+
* The current number of listeners for the signal.
15+
*/
1516
numListeners: number;
1617

1718
/**

src/org/osflash/signals/ISlot.ts

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ export interface ISlot {
1111
* The listener associated with this slot.
1212
*/
1313
listener: Function;
14-
/*function set listener(value:Function):void;*/
1514

1615
/**
1716
* Allows the ISlot to inject parameters when dispatching. The params will be at
@@ -23,7 +22,6 @@ export interface ISlot {
2322
* function handler(name:String, num:int):void{}
2423
*/
2524
params: any[];
26-
/*function set params(value:Array):void;*/
2725

2826
/**
2927
* Whether this slot is automatically removed after it has been used once.
@@ -41,7 +39,6 @@ export interface ISlot {
4139
* Whether the listener is called on execution. Defaults to true.
4240
*/
4341
enabled: boolean;
44-
/*function set enabled(value:Boolean):void;*/
4542

4643
/**
4744
* Executes a listener without arguments.

src/org/osflash/signals/MonoSignal.ts

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ import { ISlot } from "./ISlot";
1212
* A MonoSignal can have only one listener.
1313
*/
1414
export class MonoSignal implements ISignal {
15-
protected _valueClasses: any[]; // of Class
15+
protected _valueClasses: any[]; // of Class
1616

1717
protected slot: Slot;
1818

@@ -29,7 +29,10 @@ export class MonoSignal implements ISignal {
2929
*/
3030
constructor(...valueClasses) {
3131
// Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
32-
this.valueClasses = (valueClasses.length === 1 && valueClasses[0] instanceof Array) ? valueClasses[0] : valueClasses;
32+
this.valueClasses =
33+
valueClasses.length === 1 && valueClasses[0] instanceof Array
34+
? valueClasses[0]
35+
: valueClasses;
3336
}
3437

3538
/**
@@ -44,11 +47,17 @@ export class MonoSignal implements ISignal {
4447
public set valueClasses(value: any[]) {
4548
// Clone so the Array cannot be affected from outside.
4649
this._valueClasses = value ? value.slice() : [];
47-
for (let i: number = this._valueClasses.length; i--;) {
50+
for (let i: number = this._valueClasses.length; i--; ) {
4851
if (typeof this._valueClasses[i] !== "function") {
49-
throw new Error("Invalid valueClasses argument: " +
50-
"item at index " + i + " should be a Class but was:<" +
51-
this._valueClasses[i] + "'>." + this._valueClasses[i]); // @CHANGED - temp replacement for getQualifiedClassByName()
52+
throw new Error(
53+
"Invalid valueClasses argument: " +
54+
"item at index " +
55+
i +
56+
" should be a Class but was:<" +
57+
this._valueClasses[i] +
58+
"'>." +
59+
this._valueClasses[i]
60+
); // @CHANGED - temp replacement for getQualifiedClassByName()
5261
}
5362
}
5463
}
@@ -106,23 +115,34 @@ export class MonoSignal implements ISignal {
106115

107116
// Cannot dispatch fewer objects than declared classes.
108117
if (numValueObjects < numValueClasses) {
109-
throw new Error("Incorrect number of arguments. " +
110-
"Expected at least " + numValueClasses + " but received " +
111-
numValueObjects + ".");
118+
throw new Error(
119+
"Incorrect number of arguments. " +
120+
"Expected at least " +
121+
numValueClasses +
122+
" but received " +
123+
numValueObjects +
124+
"."
125+
);
112126
}
113127

114128
// Cannot dispatch differently typed objects than declared classes.
115129
for (let i: number = 0; i < numValueClasses; i++) {
116130
// Optimized for the optimistic case that values are correct.
117131
if (
118132
valueObjects[i] === null ||
119-
(valueObjects[i] instanceof this._valueClasses[i] || valueObjects[i].constructor === this._valueClasses[i])
133+
(valueObjects[i] instanceof this._valueClasses[i] ||
134+
valueObjects[i].constructor === this._valueClasses[i])
120135
) {
121136
continue;
122137
}
123138

124-
throw new Error("Value object <" + valueObjects[i]
125-
+ "> is not an instance of <" + this._valueClasses[i] + ">.");
139+
throw new Error(
140+
"Value object <" +
141+
valueObjects[i] +
142+
"> is not an instance of <" +
143+
this._valueClasses[i] +
144+
">."
145+
);
126146
}
127147

128148
// Broadcast to the one listener.
@@ -131,13 +151,17 @@ export class MonoSignal implements ISignal {
131151
}
132152
}
133153

134-
protected registerListener(listener: Function, once: boolean = false): ISlot {
154+
protected registerListener(
155+
listener: Function,
156+
once: boolean = false
157+
): ISlot {
135158
if (this.slot) {
136159
// If the listener exits previously added, definitely don't add it.
137-
throw new Error("You cannot add or addOnce with a listener already added, remove the current listener first.");
160+
throw new Error(
161+
"You cannot add or addOnce with a listener already added, remove the current listener first."
162+
);
138163
}
139164

140165
return (this.slot = new Slot(listener, this, once));
141166
}
142-
143167
}

src/org/osflash/signals/OnceSignal.ts

Lines changed: 39 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { Slot } from "./Slot";
2020
* Project home: <a target="_top" href="http://github.com/robertpenner/as3-signals/">http://github.com/robertpenner/as3-signals/</a>
2121
*/
2222
export class OnceSignal implements IOnceSignal {
23-
protected _valueClasses: any[]; // of Class
23+
protected _valueClasses: any[]; // of Class
2424
protected slots: SlotList = SlotList.NIL;
2525

2626
/**
@@ -36,7 +36,10 @@ export class OnceSignal implements IOnceSignal {
3636
*/
3737
constructor(...valueClasses) {
3838
// Cannot use super.apply(null, valueClasses), so allow the subclass to call super(valueClasses).
39-
this.valueClasses = (valueClasses.length === 1 && valueClasses[0] instanceof Array) ? valueClasses[0] : valueClasses;
39+
this.valueClasses =
40+
valueClasses.length === 1 && valueClasses[0] instanceof Array
41+
? valueClasses[0]
42+
: valueClasses;
4043
}
4144

4245
/**
@@ -51,11 +54,17 @@ export class OnceSignal implements IOnceSignal {
5154
public set valueClasses(value: any[]) {
5255
// Clone so the Array cannot be affected from outside.
5356
this._valueClasses = value ? value.slice() : [];
54-
for (let i: number = this._valueClasses.length; i--;) {
57+
for (let i: number = this._valueClasses.length; i--; ) {
5558
if (!(this._valueClasses[i] instanceof Object)) {
56-
throw new Error("Invalid valueClasses argument: " +
57-
"item at index " + i + " should be a Class but was:<" +
58-
this._valueClasses[i] + ">." + this._valueClasses[i]); // @CHANGED - temp replacement for getQualifiedClassByName()
59+
throw new Error(
60+
"Invalid valueClasses argument: " +
61+
"item at index " +
62+
i +
63+
" should be a Class but was:<" +
64+
this._valueClasses[i] +
65+
">." +
66+
this._valueClasses[i]
67+
); // @CHANGED - temp replacement for getQualifiedClassByName()
5968
}
6069
}
6170
}
@@ -96,30 +105,40 @@ export class OnceSignal implements IOnceSignal {
96105
* @throws ArgumentError <code>ArgumentError</code>: Value object is not an instance of the appropriate valueClasses Class.
97106
*/
98107
public dispatch(...valueObjects): void {
99-
100108
// If valueClasses is empty, value objects are not type-checked.
101109
let numValueClasses: number = this._valueClasses.length;
102110
let numValueObjects: number = valueObjects.length;
103111

104112
// Cannot dispatch fewer objects than declared classes.
105113
if (numValueObjects < numValueClasses) {
106-
throw new Error("Incorrect number of arguments. " +
107-
"Expected at least " + numValueClasses + " but received " +
108-
numValueObjects + ".");
114+
throw new Error(
115+
"Incorrect number of arguments. " +
116+
"Expected at least " +
117+
numValueClasses +
118+
" but received " +
119+
numValueObjects +
120+
"."
121+
);
109122
}
110123

111124
// Cannot dispatch differently typed objects than declared classes.
112125
for (let i: number = 0; i < numValueClasses; i++) {
113126
// Optimized for the optimistic case that values are correct.
114127
if (
115128
valueObjects[i] === null ||
116-
(valueObjects[i] instanceof this._valueClasses[i] || valueObjects[i].constructor === this._valueClasses[i])
129+
(valueObjects[i] instanceof this._valueClasses[i] ||
130+
valueObjects[i].constructor === this._valueClasses[i])
117131
) {
118132
continue;
119133
}
120134

121-
throw new Error("Value object <" + valueObjects[i]
122-
+ "> is not an instance of <" + this._valueClasses[i] + ">.");
135+
throw new Error(
136+
"Value object <" +
137+
valueObjects[i] +
138+
"> is not an instance of <" +
139+
this._valueClasses[i] +
140+
">."
141+
);
123142
}
124143

125144
// Broadcast to listeners.
@@ -132,7 +151,10 @@ export class OnceSignal implements IOnceSignal {
132151
}
133152
}
134153

135-
protected registerListener(listener: Function, once: boolean = false): ISlot {
154+
protected registerListener(
155+
listener: Function,
156+
once: boolean = false
157+
): ISlot {
136158
if (this.registrationPossible(listener, once)) {
137159
let newSlot: ISlot = new Slot(listener, this, once);
138160
this.slots = this.slots.prepend(newSlot);
@@ -155,7 +177,9 @@ export class OnceSignal implements IOnceSignal {
155177
if (existingSlot.once !== once) {
156178
// If the listener was previously added, definitely don't add it again.
157179
// But throw an exception if their once values differ.
158-
throw new Error("You cannot addOnce() then add() the same listener without removing the relationship first.");
180+
throw new Error(
181+
"You cannot addOnce() then add() the same listener without removing the relationship first."
182+
);
159183
}
160184

161185
return false; // Listener was already registered.

0 commit comments

Comments
 (0)