build: enable JS semicolons (#22783)
This commit is contained in:
Samuel Attard
GitHub
parent
24e21467b9
commit
5d657dece4
354 changed files with 21512 additions and 21510 deletions
|
|
@ -1,226 +1,226 @@
|
|||
import { expect } from 'chai'
|
||||
import { deprecate } from 'electron'
|
||||
import { expect } from 'chai';
|
||||
import { deprecate } from 'electron';
|
||||
|
||||
describe('deprecate', () => {
|
||||
let throwing: boolean
|
||||
let throwing: boolean;
|
||||
|
||||
beforeEach(() => {
|
||||
throwing = process.throwDeprecation
|
||||
deprecate.setHandler(null)
|
||||
process.throwDeprecation = true
|
||||
})
|
||||
throwing = process.throwDeprecation;
|
||||
deprecate.setHandler(null);
|
||||
process.throwDeprecation = true;
|
||||
});
|
||||
|
||||
afterEach(() => {
|
||||
process.throwDeprecation = throwing
|
||||
})
|
||||
process.throwDeprecation = throwing;
|
||||
});
|
||||
|
||||
it('allows a deprecation handler function to be specified', () => {
|
||||
const messages: string[] = []
|
||||
const messages: string[] = [];
|
||||
|
||||
deprecate.setHandler(message => {
|
||||
messages.push(message)
|
||||
})
|
||||
messages.push(message);
|
||||
});
|
||||
|
||||
deprecate.log('this is deprecated')
|
||||
expect(messages).to.deep.equal(['this is deprecated'])
|
||||
})
|
||||
deprecate.log('this is deprecated');
|
||||
expect(messages).to.deep.equal(['this is deprecated']);
|
||||
});
|
||||
|
||||
it('returns a deprecation handler after one is set', () => {
|
||||
const messages = []
|
||||
const messages = [];
|
||||
|
||||
deprecate.setHandler(message => {
|
||||
messages.push(message)
|
||||
})
|
||||
messages.push(message);
|
||||
});
|
||||
|
||||
deprecate.log('this is deprecated')
|
||||
expect(deprecate.getHandler()).to.be.a('function')
|
||||
})
|
||||
deprecate.log('this is deprecated');
|
||||
expect(deprecate.getHandler()).to.be.a('function');
|
||||
});
|
||||
|
||||
it('renames a property', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
const oldProp = 'dingyOldName'
|
||||
const newProp = 'shinyNewName'
|
||||
const oldProp = 'dingyOldName';
|
||||
const newProp = 'shinyNewName';
|
||||
|
||||
let value = 0
|
||||
const o: Record<string, number> = { [newProp]: value }
|
||||
expect(o).to.not.have.property(oldProp)
|
||||
expect(o).to.have.property(newProp).that.is.a('number')
|
||||
let value = 0;
|
||||
const o: Record<string, number> = { [newProp]: value };
|
||||
expect(o).to.not.have.property(oldProp);
|
||||
expect(o).to.have.property(newProp).that.is.a('number');
|
||||
|
||||
deprecate.renameProperty(o, oldProp, newProp)
|
||||
o[oldProp] = ++value
|
||||
deprecate.renameProperty(o, oldProp, newProp);
|
||||
o[oldProp] = ++value;
|
||||
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include(oldProp)
|
||||
expect(msg).to.include(newProp)
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include(oldProp);
|
||||
expect(msg).to.include(newProp);
|
||||
|
||||
expect(o).to.have.property(newProp).that.is.equal(value)
|
||||
expect(o).to.have.property(oldProp).that.is.equal(value)
|
||||
})
|
||||
expect(o).to.have.property(newProp).that.is.equal(value);
|
||||
expect(o).to.have.property(oldProp).that.is.equal(value);
|
||||
});
|
||||
|
||||
it('doesn\'t deprecate a property not on an object', () => {
|
||||
const o: any = {}
|
||||
const o: any = {};
|
||||
|
||||
expect(() => {
|
||||
deprecate.removeProperty(o, 'iDoNotExist')
|
||||
}).to.throw(/iDoNotExist/)
|
||||
})
|
||||
deprecate.removeProperty(o, 'iDoNotExist');
|
||||
}).to.throw(/iDoNotExist/);
|
||||
});
|
||||
|
||||
it('deprecates a property of an object', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
const prop = 'itMustGo'
|
||||
const o = { [prop]: 0 }
|
||||
const prop = 'itMustGo';
|
||||
const o = { [prop]: 0 };
|
||||
|
||||
deprecate.removeProperty(o, prop)
|
||||
deprecate.removeProperty(o, prop);
|
||||
|
||||
const temp = o[prop]
|
||||
const temp = o[prop];
|
||||
|
||||
expect(temp).to.equal(0)
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include(prop)
|
||||
})
|
||||
expect(temp).to.equal(0);
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include(prop);
|
||||
});
|
||||
|
||||
it('deprecates a property of an but retains the existing accessors and setters', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
const prop = 'itMustGo'
|
||||
let i = 1
|
||||
const prop = 'itMustGo';
|
||||
let i = 1;
|
||||
const o = {
|
||||
get itMustGo () {
|
||||
return i
|
||||
return i;
|
||||
},
|
||||
set itMustGo (thing) {
|
||||
i = thing + 1
|
||||
i = thing + 1;
|
||||
}
|
||||
}
|
||||
};
|
||||
|
||||
deprecate.removeProperty(o, prop)
|
||||
deprecate.removeProperty(o, prop);
|
||||
|
||||
expect(o[prop]).to.equal(1)
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include(prop)
|
||||
o[prop] = 2
|
||||
expect(o[prop]).to.equal(3)
|
||||
})
|
||||
expect(o[prop]).to.equal(1);
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include(prop);
|
||||
o[prop] = 2;
|
||||
expect(o[prop]).to.equal(3);
|
||||
});
|
||||
|
||||
it('warns exactly once when a function is deprecated with no replacement', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
function oldFn () { return 'hello' }
|
||||
const deprecatedFn = deprecate.removeFunction(oldFn, 'oldFn')
|
||||
deprecatedFn()
|
||||
function oldFn () { return 'hello'; }
|
||||
const deprecatedFn = deprecate.removeFunction(oldFn, 'oldFn');
|
||||
deprecatedFn();
|
||||
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include('oldFn')
|
||||
})
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include('oldFn');
|
||||
});
|
||||
|
||||
it('warns exactly once when a function is deprecated with a replacement', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
function oldFn () { return 'hello' }
|
||||
function newFn () { return 'goodbye' }
|
||||
const deprecatedFn = deprecate.renameFunction(oldFn, newFn)
|
||||
deprecatedFn()
|
||||
function oldFn () { return 'hello'; }
|
||||
function newFn () { return 'goodbye'; }
|
||||
const deprecatedFn = deprecate.renameFunction(oldFn, newFn);
|
||||
deprecatedFn();
|
||||
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include('oldFn')
|
||||
expect(msg).to.include('newFn')
|
||||
})
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include('oldFn');
|
||||
expect(msg).to.include('newFn');
|
||||
});
|
||||
|
||||
it('warns only once per item', () => {
|
||||
const messages: string[] = []
|
||||
deprecate.setHandler(message => messages.push(message))
|
||||
const messages: string[] = [];
|
||||
deprecate.setHandler(message => messages.push(message));
|
||||
|
||||
const key = 'foo'
|
||||
const val = 'bar'
|
||||
const o = { [key]: val }
|
||||
deprecate.removeProperty(o, key)
|
||||
const key = 'foo';
|
||||
const val = 'bar';
|
||||
const o = { [key]: val };
|
||||
deprecate.removeProperty(o, key);
|
||||
|
||||
for (let i = 0; i < 3; ++i) {
|
||||
expect(o[key]).to.equal(val)
|
||||
expect(messages).to.have.length(1)
|
||||
expect(o[key]).to.equal(val);
|
||||
expect(messages).to.have.length(1);
|
||||
}
|
||||
})
|
||||
});
|
||||
|
||||
it('warns if deprecated property is already set', () => {
|
||||
let msg
|
||||
deprecate.setHandler(m => { msg = m })
|
||||
let msg;
|
||||
deprecate.setHandler(m => { msg = m; });
|
||||
|
||||
const oldProp = 'dingyOldName'
|
||||
const newProp = 'shinyNewName'
|
||||
const oldProp = 'dingyOldName';
|
||||
const newProp = 'shinyNewName';
|
||||
|
||||
const o: Record<string, number> = { [oldProp]: 0 }
|
||||
deprecate.renameProperty(o, oldProp, newProp)
|
||||
const o: Record<string, number> = { [oldProp]: 0 };
|
||||
deprecate.renameProperty(o, oldProp, newProp);
|
||||
|
||||
expect(msg).to.be.a('string')
|
||||
expect(msg).to.include(oldProp)
|
||||
expect(msg).to.include(newProp)
|
||||
})
|
||||
expect(msg).to.be.a('string');
|
||||
expect(msg).to.include(oldProp);
|
||||
expect(msg).to.include(newProp);
|
||||
});
|
||||
|
||||
it('throws an exception if no deprecation handler is specified', () => {
|
||||
expect(() => {
|
||||
deprecate.log('this is deprecated')
|
||||
}).to.throw(/this is deprecated/)
|
||||
})
|
||||
deprecate.log('this is deprecated');
|
||||
}).to.throw(/this is deprecated/);
|
||||
});
|
||||
|
||||
it('warns when a function is deprecated in favor of a property', () => {
|
||||
const warnings: string[] = []
|
||||
deprecate.setHandler(warning => warnings.push(warning))
|
||||
const warnings: string[] = [];
|
||||
deprecate.setHandler(warning => warnings.push(warning));
|
||||
|
||||
const newProp = 'newProp'
|
||||
const newProp = 'newProp';
|
||||
const mod: any = {
|
||||
_oldGetterFn () { return 'getter' },
|
||||
_oldSetterFn () { return 'setter' }
|
||||
}
|
||||
_oldGetterFn () { return 'getter'; },
|
||||
_oldSetterFn () { return 'setter'; }
|
||||
};
|
||||
|
||||
deprecate.fnToProperty(mod, 'newProp', '_oldGetterFn', '_oldSetterFn')
|
||||
deprecate.fnToProperty(mod, 'newProp', '_oldGetterFn', '_oldSetterFn');
|
||||
|
||||
mod.oldGetterFn()
|
||||
mod.oldSetterFn()
|
||||
mod.oldGetterFn();
|
||||
mod.oldSetterFn();
|
||||
|
||||
expect(warnings).to.have.lengthOf(2)
|
||||
expect(warnings).to.have.lengthOf(2);
|
||||
|
||||
expect(warnings[0]).to.include('oldGetterFn')
|
||||
expect(warnings[0]).to.include(newProp)
|
||||
expect(warnings[0]).to.include('oldGetterFn');
|
||||
expect(warnings[0]).to.include(newProp);
|
||||
|
||||
expect(warnings[1]).to.include('oldSetterFn')
|
||||
expect(warnings[1]).to.include(newProp)
|
||||
})
|
||||
expect(warnings[1]).to.include('oldSetterFn');
|
||||
expect(warnings[1]).to.include(newProp);
|
||||
});
|
||||
|
||||
describe('moveAPI', () => {
|
||||
beforeEach(() => {
|
||||
deprecate.setHandler(null)
|
||||
})
|
||||
deprecate.setHandler(null);
|
||||
});
|
||||
|
||||
it('should call the original method', () => {
|
||||
const warnings = []
|
||||
deprecate.setHandler(warning => warnings.push(warning))
|
||||
const warnings = [];
|
||||
deprecate.setHandler(warning => warnings.push(warning));
|
||||
|
||||
let called = false
|
||||
let called = false;
|
||||
const fn = () => {
|
||||
called = true
|
||||
}
|
||||
const deprecated = deprecate.moveAPI(fn, 'old', 'new')
|
||||
deprecated()
|
||||
expect(called).to.equal(true)
|
||||
})
|
||||
called = true;
|
||||
};
|
||||
const deprecated = deprecate.moveAPI(fn, 'old', 'new');
|
||||
deprecated();
|
||||
expect(called).to.equal(true);
|
||||
});
|
||||
|
||||
it('should log the deprecation warning once', () => {
|
||||
const warnings: string[] = []
|
||||
deprecate.setHandler(warning => warnings.push(warning))
|
||||
const warnings: string[] = [];
|
||||
deprecate.setHandler(warning => warnings.push(warning));
|
||||
|
||||
const deprecated = deprecate.moveAPI(() => null, 'old', 'new')
|
||||
deprecated()
|
||||
expect(warnings).to.have.lengthOf(1)
|
||||
deprecated()
|
||||
expect(warnings).to.have.lengthOf(1)
|
||||
expect(warnings[0]).to.equal('\'old\' is deprecated and will be removed. Please use \'new\' instead.')
|
||||
})
|
||||
})
|
||||
})
|
||||
const deprecated = deprecate.moveAPI(() => null, 'old', 'new');
|
||||
deprecated();
|
||||
expect(warnings).to.have.lengthOf(1);
|
||||
deprecated();
|
||||
expect(warnings).to.have.lengthOf(1);
|
||||
expect(warnings[0]).to.equal('\'old\' is deprecated and will be removed. Please use \'new\' instead.');
|
||||
});
|
||||
});
|
||||
});
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue