refactor: The Options interface was renamed to ProjectOptions

BREAKING CHANGE: The `Options` interface was renamed to `ProjectOptions`. This was so it's less ambiguous.

breaking-changes.md

@@ -4,6 +4,8 @@ View [CHANGELOG.md](CHANGELOG.md) for more detail on releases. This file is only
 
 ## Version 19
 
+* `Options` interface renamed to `ProjectOptions` in order to be more specific.
+
 ### Source file dependencies automatically added
 
 Referenced source files in module specifiers and references are now added to the project when constructing a project and providing a tsconfig.

lib/ts-simple-ast.d.ts

@@ -339,7 +339,7 @@ export interface FileSystemHost {
     glob(patterns: ReadonlyArray<string>): string[];
 }
 
-export interface Options {
+export interface ProjectOptions {
     /** Compiler options */
     compilerOptions?: CompilerOptions;
     /** File path to the tsconfig.json file */
@@ -367,7 +367,7 @@ export declare class Project {
      * Initializes a new instance.
      * @param options - Optional options.
      */
-    constructor(options?: Options);
+    constructor(options?: ProjectOptions);
     /** Gets the manipulation settings. */
     readonly manipulationSettings: ManipulationSettingsContainer;
     /** Gets the compiler options for modification. */

src/Project.ts

@@ -8,7 +8,7 @@ import { SourceFileStructure } from "./structures";
 import { ts, CompilerOptions } from "./typescript";
 import { ArrayUtils, FileUtils, matchGlobs, TsConfigResolver } from "./utils";
 
-export interface Options { // todo: rename to ProjectOptions
+export interface ProjectOptions {
     /** Compiler options */
     compilerOptions?: CompilerOptions;
     /** File path to the tsconfig.json file */
@@ -43,7 +43,7 @@ export class Project {
      * Initializes a new instance.
      * @param options - Optional options.
      */
-    constructor(options: Options = {}) {
+    constructor(options: ProjectOptions = {}) {
         // setup file system
         let fileSystem = options.fileSystem;
         if (fileSystem != null && options.useVirtualFileSystem)

src/main.ts

@@ -4,7 +4,7 @@ export * from "./compiler";
 export * from "./errors/classes";
 export { Directory, DirectoryAddOptions, DirectoryCopyOptions, DirectoryEmitResult, DirectoryMoveOptions, FileSystemHost } from "./fileSystem";
 export * from "./options";
-export { Options, Project, SourceFileCreateOptions } from "./Project";
+export { ProjectOptions, Project, SourceFileCreateOptions } from "./Project";
 export { Project as default } from "./Project";
 export * from "./structures";
 export { Constructor, WriterFunction } from "./types";

src/tests/projectTests.ts

@@ -5,7 +5,7 @@ import { ClassDeclaration, EmitResult, MemoryEmitResult, InterfaceDeclaration, N
 import * as errors from "../errors";
 import { VirtualFileSystemHost } from "../fileSystem";
 import { IndentationText } from "../options";
-import { Project, Options } from "../Project";
+import { Project, ProjectOptions } from "../Project";
 import { SourceFileStructure } from "../structures";
 import { CompilerOptions, ScriptTarget, SyntaxKind, ts } from "../typescript";
 import * as testHelpers from "./testHelpers";
@@ -93,7 +93,7 @@ describe(nameof(Project), () => {
         });
     });
 
-    function fileDependencyResolutionSetup(options: Options = {}) {
+    function fileDependencyResolutionSetup(options: ProjectOptions = {}) {
         const fileSystem = new VirtualFileSystemHost();
 
         fileSystem.writeFileSync("/package.json", `{ "name": "testing", "version": "0.0.1" }`);