Skip to content

Commit 8a6609f

Browse files
author
Nicholas Pape
authored
Revert previous change causing breakage in SPFx core scenario (microsoft#139)
* Revert "Update sass dependencies. (microsoft#138)" This reverts commit 7d99750. * Changefile
1 parent 3a42515 commit 8a6609f

File tree

22 files changed

+378
-249
lines changed

22 files changed

+378
-249
lines changed

‎.vscode/settings.json‎

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,6 @@
55
// Controls after how many characters the editor will wrap to the next line. Setting this to 0 turns on viewport width wrapping
66
// When enabled, will trim trailing whitespace when you save a file.
77
"files.trimTrailingWhitespace": true,
8-
// Auto formats on save
9-
"editor.formatOnSave": true,
108
// Controls if the editor should automatically close brackets after opening them
119
"editor.autoClosingBrackets": false,
1210
// Configure glob patterns for excluding files and folders in searches. Inherits all glob patterns from the file.exclude setting.

‎api-extractor/src/ApiDefinitionReference.ts‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
/**
2-
* An API definition reference that is used to locate the documentation of exported
3-
* API items that may or may not belong to an external package.
4-
*
5-
* The format of the API definition reference is:
2+
* An API definition reference that is used to locate the documentation of exported
3+
* API items that may or may not belong to an external package.
4+
*
5+
* The format of the API definition reference is:
66
* scopeName/packageName:exportName.memberName
7-
*
8-
* The following are valid API definition references:
7+
*
8+
* The following are valid API definition references:
99
* \@microsoft/sp-core-library:DisplayMode
1010
* \@microsoft/sp-core-library:Guid
1111
* \@microsoft/sp-core-library:Guid.equals
@@ -14,7 +14,7 @@
1414
export interface IApiDefinintionReferenceParts {
1515
/**
1616
* This is an optional property to denote that a package name is scoped under this name.
17-
* For example, a common case is when having the '@microsoft' scope name in the
17+
* For example, a common case is when having the '@microsoft' scope name in the
1818
* API definition reference: '\@microsoft/sp-core-library'.
1919
*/
2020
scopeName: string;
@@ -27,15 +27,15 @@ export interface IApiDefinintionReferenceParts {
2727
*/
2828
exportName: string;
2929
/**
30-
* The name of the member API item.
30+
* The name of the member API item.
3131
*/
3232
memberName: string;
3333
}
3434

3535
/**
3636
* A scope and package name are semantic information within an API reference expression.
3737
* If there is no scope or package, then the corresponding values will be an empty string.
38-
*
38+
*
3939
* Example: '@microsoft/Utilities' -> \{ scope: '@microsoft', package: 'Utilities' \}
4040
* Example: 'Utilities' -> \{ scope: '', package: 'Utilities' \}
4141
*/
@@ -164,7 +164,7 @@ export default class ApiDefinitionReference {
164164
/**
165165
* Stringifies the ApiDefinitionReferenceOptions up and including the
166166
* scope and package name.
167-
*
167+
*
168168
* Example output: '@microsoft/Utilities'
169169
*/
170170
public toScopePackageString(): string {
@@ -180,7 +180,7 @@ export default class ApiDefinitionReference {
180180
/**
181181
* Stringifies the ApiDefinitionReferenceOptions up and including the
182182
* scope, package and export name.
183-
*
183+
*
184184
* Example output: '@microsoft/Utilities.Parse'
185185
*/
186186
public toExportString(): string {
@@ -194,7 +194,7 @@ export default class ApiDefinitionReference {
194194
/**
195195
* Stringifies the ApiDefinitionReferenceOptions up and including the
196196
* scope, package, export and member name.
197-
*
197+
*
198198
* Example output: '@microsoft/Utilities.Parse.parseJsonToString'
199199
*/
200200
public toMemberString(): string {

‎api-extractor/src/DocElementParser.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -253,12 +253,12 @@ export default class DocElementParser {
253253
return;
254254
}
255255

256-
// We are going to copy the resolvedApiItem's documentation
256+
// We are going to copy the resolvedApiItem's documentation
257257
// We must make sure it's documentation can be completed,
258-
// if we cannot, an error will be reported viathe documentation error handler.
259-
// This will only be the case our resolvedApiItem was created from a local
258+
// if we cannot, an error will be reported viathe documentation error handler.
259+
// This will only be the case our resolvedApiItem was created from a local
260260
// ApiItem. Resolutions from JSON will have an undefined 'apiItem' property.
261-
// Example: a circular reference will report an error.
261+
// Example: a circular reference will report an error.
262262
if (resolvedApiItem.apiItem) {
263263
resolvedApiItem.apiItem.completeInitialization();
264264
}

‎api-extractor/src/DocItemLoader.ts‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ export interface IParsedScopeName {
2626
}
2727

2828
/**
29-
* A loader for locating the IDocItem associated with a given project and API item, or
29+
* A loader for locating the IDocItem associated with a given project and API item, or
3030
* for locating an ApiItem locally.
3131
* No processing on the IDocItem orApiItem should be done in this class, this class is only
3232
* concerned with communicating state.
@@ -58,11 +58,11 @@ export default class DocItemLoader {
5858
apiPackage: ApiPackage,
5959
reportError: (message: string) => void): ResolvedApiItem {
6060

61-
// If there is a packageName then there must be a scopeName, and they
61+
// If there is a packageName then there must be a scopeName, and they
6262
// both must match the current scope and package we are in.
6363
// We can take advantage of '&&' being evaluated left to right.
6464
if (!apiDefinitionRef.packageName && !apiDefinitionRef.scopeName) {
65-
// Resolution for local references
65+
// Resolution for local references
6666
return this.resolveLocalReferences(apiDefinitionRef, apiPackage, reportError);
6767
} else {
6868
// Resolution for references in JSON files
@@ -71,7 +71,7 @@ export default class DocItemLoader {
7171
}
7272

7373
/**
74-
* Resolution of API definition references in the scenario that the reference given indicates
74+
* Resolution of API definition references in the scenario that the reference given indicates
7575
* that we should search within the current ApiPackage to resolve.
7676
* No processing on the ApiItem should be done here, this class is only concerned
7777
* with communicating state.
@@ -111,9 +111,9 @@ export default class DocItemLoader {
111111
}
112112

113113
/**
114-
* Resolution of API definition references in the scenario that the reference given indicates
114+
* Resolution of API definition references in the scenario that the reference given indicates
115115
* that we should search outside of this ApiPackage and instead search within the JSON API file
116-
* that is associated with the apiDefinitionRef.
116+
* that is associated with the apiDefinitionRef.
117117
*/
118118
public resolveJsonReferences(apiDefinitionRef: ApiDefinitionReference,
119119
reportError: (message: string) => void): ResolvedApiItem {
@@ -125,7 +125,7 @@ export default class DocItemLoader {
125125
return undefined;
126126
}
127127

128-
// found JSON package, now ensure export name is there
128+
// found JSON package, now ensure export name is there
129129
// hasOwnProperty() not needed for JJU objects
130130
if (!(apiDefinitionRef.exportName in docPackage.exports)) {
131131
reportError(`Unable to find referenced export \"${apiDefinitionRef.toExportString()}\""`);
@@ -210,7 +210,7 @@ export default class DocItemLoader {
210210
}
211211

212212
/**
213-
* Loads the API documentation json file and validates that it conforms to our schema. If it does,
213+
* Loads the API documentation json file and validates that it conforms to our schema. If it does,
214214
* then the json file is saved in the cache and returned.
215215
*/
216216
public loadPackageIntoCache(packageJsonFilePath: string): IDocPackage {

‎api-extractor/src/ExternalApiHelper.ts‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -7,19 +7,19 @@ import ApiJsonGenerator from './generators/ApiJsonGenerator';
77

88
/**
99
* ExternalApiHelper has the specific use case of generating an API json file from third party definition files.
10-
* This class is invoked by the gulp-core-build-typescript gulpfile, where the external package names are
11-
* hard wired.
12-
* The job of this method is almost the same as the API Exactractor task that is executed on first party packages,
10+
* This class is invoked by the gulp-core-build-typescript gulpfile, where the external package names are
11+
* hard wired.
12+
* The job of this method is almost the same as the API Exactractor task that is executed on first party packages,
1313
* with the exception that all packages analyzed here are external packages with definition files.
1414
*/
1515
export default class ExternalApiHelper {
1616

1717
/**
18-
* @param rootDir - the absolute path containing a 'package.json' file and is also a parent of the
18+
* @param rootDir - the absolute path containing a 'package.json' file and is also a parent of the
1919
* external package file. Ex: build.absolute_build_path.
20-
* @param libFolder - the path to the lib folder relative to the rootDir, this is where
20+
* @param libFolder - the path to the lib folder relative to the rootDir, this is where
2121
* 'external-api-json/external_package.api.json' file will be written. Ex: 'lib'.
22-
* @param externalPackageFilePath - the path to the '*.d.ts' file of the external package relative to the rootDir.
22+
* @param externalPackageFilePath - the path to the '*.d.ts' file of the external package relative to the rootDir.
2323
* Ex: 'resources/external-api-json/es6-promise/index.t.ds'
2424
*/
2525
public static generateApiJson(rootDir: string, libFolder: string, externalPackageFilePath: string): void {

‎api-extractor/src/Extractor.ts‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -108,11 +108,11 @@ export default class Extractor {
108108
}
109109

110110
/**
111-
* Scans for external package api files and loads them into the docItemLoader member before
111+
* Scans for external package api files and loads them into the docItemLoader member before
112112
* any API analyzation begins.
113-
*
114-
* @param externalJsonCollectionPath - an absolute path to to the folder that contains all the external
115-
* api json files.
113+
*
114+
* @param externalJsonCollectionPath - an absolute path to to the folder that contains all the external
115+
* api json files.
116116
* Ex: if externalJsonPath is './resources', then in that folder
117117
* are 'es6-collections.api.json', 'es6-promise.api.json', etc.
118118
*/

‎api-extractor/src/IDocElement.ts‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
/**
22
* The following interfaces represent Doc Elements of a
33
* documentation block.
4-
*
5-
* @remarks if adding a new 'kind', then it is essential that you update the
4+
*
5+
* @remarks if adding a new 'kind', then it is essential that you update the
66
* methods within DocElementParser (getasText() and parse()).
77
*/
88
export interface IBaseDocElement {

‎api-extractor/src/IDocItem.ts‎

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,9 @@ export enum AccessModifier {
1515

1616
/**
1717
* The enum value of an IDocEnum.
18-
*
18+
*
1919
* IDocEnumValue does not extend the IDocITem base class
20-
* because the summary is not required.
20+
* because the summary is not required.
2121
*/
2222
export interface IDocEnumValue {
2323
value: string;
@@ -36,7 +36,7 @@ export interface IDocParam {
3636
name: string;
3737

3838
/**
39-
* describes the parameter
39+
* describes the parameter
4040
*/
4141
description: IDocElement[];
4242

@@ -72,10 +72,10 @@ export interface IDocReturnValue {
7272
}
7373

7474
/**
75-
* DocItems are the typescript adaption of the json schemas
75+
* DocItems are the typescript adaption of the json schemas
7676
* defined in API-json-schema.json. IDocElement is a component
77-
* for IDocItems because they represent formated rich text.
78-
*
77+
* for IDocItems because they represent formated rich text.
78+
*
7979
* This is the base class for other DocItem types.
8080
*/
8181
export interface IDocBase {
@@ -133,7 +133,7 @@ export interface IDocMethod extends IDocBase {
133133
signature: string;
134134

135135
/**
136-
* the access modifier of the method
136+
* the access modifier of the method
137137
*/
138138
accessModifier: AccessModifier;
139139

@@ -180,7 +180,7 @@ export interface IDocFunction extends IDocBase {
180180

181181
/**
182182
* IDocClass represetns an exported class.
183-
*
183+
*
184184
*/
185185
export interface IDocClass extends IDocBase {
186186
/**
@@ -250,7 +250,7 @@ export interface IDocInterface extends IDocBase {
250250
}
251251

252252
/**
253-
* IDocPackage is an object contaning the exported
253+
* IDocPackage is an object contaning the exported
254254
* definions of this API package. The exports can include:
255255
* classes, interfaces, enums, functions.
256256
*/
@@ -267,8 +267,8 @@ export interface IDocPackage {
267267

268268
/**
269269
* The following are needed so that this interface and can share
270-
* common properties with others that extend IDocBase. The IDocPackage
271-
* does not extend the IDocBase because a summary is not required for
270+
* common properties with others that extend IDocBase. The IDocPackage
271+
* does not extend the IDocBase because a summary is not required for
272272
* a package.
273273
*/
274274
isBeta?: boolean;

‎api-extractor/src/ResolvedApiItem.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ import { IDocItem } from './IDocItem';
55
import ApiJsonFile from './generators/ApiJsonFile';
66

77
/**
8-
* A class to abstract away the difference between an item from our public API that could be
8+
* A class to abstract away the difference between an item from our public API that could be
99
* represented by either an ApiItem or an IDocItem that is retrieved from a JSON file.
1010
*/
1111
export default class ResolvedApiItem {
@@ -24,7 +24,7 @@ export default class ResolvedApiItem {
2424

2525
/**
2626
* A function to abstract the construction of a ResolvedApiItem instance
27-
* from an ApiItem.
27+
* from an ApiItem.
2828
*/
2929
public static createFromApiItem(apiItem: ApiItem): ResolvedApiItem {
3030
return new ResolvedApiItem(
@@ -42,7 +42,7 @@ export default class ResolvedApiItem {
4242

4343
/**
4444
* A function to abstract the construction of a ResolvedApiItem instance
45-
* from a JSON object that symbolizes an IDocItem.
45+
* from a JSON object that symbolizes an IDocItem.
4646
*/
4747
public static createFromJson(docItem: IDocItem): ResolvedApiItem {
4848
let parameters: {[name: string]: IParam} = undefined;

‎api-extractor/src/TestFileComparer.ts‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,9 +16,9 @@ export default class TestFileComparer {
1616
}
1717

1818
/**
19-
* Compares the contents of two files, and returns true if they are equivalent.
20-
* Note that these files are not normally edited by a human; the "equivalence"
21-
* comparison here is intended to ignore spurious changes that might be introduced
19+
* Compares the contents of two files, and returns true if they are equivalent.
20+
* Note that these files are not normally edited by a human; the "equivalence"
21+
* comparison here is intended to ignore spurious changes that might be introduced
2222
* by a tool, e.g. Git newline normalization or an editor that strips
2323
* whitespace when saving.
2424
*/

0 commit comments

Comments
 (0)