Add setFile method, deprecate addOrReplaceFile (#510)

rokucommunity · Feb 9, 2022 · dcdc6f0 · dcdc6f0
1 parent 5a5baf8
commit dcdc6f0
Show file tree

Hide file tree

Showing 27 changed files with 580 additions and 561 deletions.
diff --git a/benchmarks/targets/parse-brs.js b/benchmarks/targets/parse-brs.js
@@ -21,7 +21,7 @@ module.exports = async (suite, name, brighterscript, projectPath, options) => {
         const promises = [];
         for (const file of files) {
             promises.push(
-                builder.program.addOrReplaceFile(file.pkgPath, file.fileContents)
+                (builder.program.addOrReplaceFile ?? builder.program.setFile)(file.pkgPath, file.fileContents)
             );
         }
         // eslint-disable-next-line @typescript-eslint/no-floating-promises

diff --git a/scripts/compile-doc-examples.ts b/scripts/compile-doc-examples.ts
@@ -184,7 +184,7 @@ class DocCompiler {
             //use the current bsconfig
             ...(this.bsconfig ?? {})
         });
-        const file = program.addOrReplaceFile({ src: `${__dirname}/rootDir/source/main.bs`, dest: 'source/main.bs' }, code);
+        const file = program.setFile({ src: `${__dirname}/rootDir/source/main.bs`, dest: 'source/main.bs' }, code);
         program.validate();
         let tranpileResult = file.transpile();
         return tranpileResult.code;

diff --git a/src/FunctionScope.spec.ts b/src/FunctionScope.spec.ts
@@ -23,7 +23,7 @@ describe('FunctionScope', () => {
         });
 
         it('returns variables defined above the specified line number', () => {
-            let file = program.addOrReplaceFile({ src: `${rootDir}/source/main.brs`, dest: 'source/main.brs' }, `
+            let file = program.setFile({ src: `${rootDir}/source/main.brs`, dest: 'source/main.brs' }, `
                 sub main()
                     var1 = 1
                     var2 = 2

diff --git a/src/LanguageServer.spec.ts b/src/LanguageServer.spec.ts
@@ -114,12 +114,12 @@ describe('LanguageServer', () => {
             ${additionalXmlContents}
             <script type="text/brightscript" uri="${name}.brs" />
         </component>`;
-        program.addOrReplaceFile(filePath, contents);
+        program.setFile(filePath, contents);
     }
 
     function addScriptFile(name: string, contents: string, extension = 'brs') {
         const filePath = s`components/${name}.${extension}`;
-        const file = program.addOrReplaceFile(filePath, contents);
+        const file = program.setFile(filePath, contents);
         if (file) {
             const document = TextDocument.create(util.pathToUri(file.pathAbsolute), 'brightscript', 1, contents);
             svr.documents._documents[document.uri] = document;
@@ -271,7 +271,7 @@ describe('LanguageServer', () => {
 
     describe('handleFileChanges', () => {
         it('only adds files that match the files array', async () => {
-            let addOrReplaceFileStub = sinon.stub().returns(Promise.resolve());
+            let setFileStub = sinon.stub().returns(Promise.resolve());
             const workspace = {
                 builder: {
                     options: {
@@ -282,7 +282,7 @@ describe('LanguageServer', () => {
                     getFileContents: sinon.stub().callsFake(() => Promise.resolve('')) as any,
                     rootDir: rootDir,
                     program: {
-                        addOrReplaceFile: <any>addOrReplaceFileStub
+                        setFile: <any>setFileStub
                     }
                 }
             } as Workspace;
@@ -295,20 +295,20 @@ describe('LanguageServer', () => {
                 pathAbsolute: mainPath
             }]);
 
-            expect(addOrReplaceFileStub.getCalls()[0]?.args[0]).to.eql({
+            expect(setFileStub.getCalls()[0]?.args[0]).to.eql({
                 src: mainPath,
                 dest: s`source/main.brs`
             });
 
             let libPath = s`${rootDir}/components/lib.brs`;
 
-            expect(addOrReplaceFileStub.callCount).to.equal(1);
+            expect(setFileStub.callCount).to.equal(1);
             await server.handleFileChanges(workspace, [{
                 type: FileChangeType.Created,
                 pathAbsolute: libPath
             }]);
             //the function should have ignored the lib file, so no additional files were added
-            expect(addOrReplaceFileStub.callCount).to.equal(1);
+            expect(setFileStub.callCount).to.equal(1);
         });
     });
 

diff --git a/src/LanguageServer.ts b/src/LanguageServer.ts
@@ -846,7 +846,7 @@ export class LanguageServer {
 
             //if we got a dest path, then the program wants this file
             if (destPath) {
-                program.addOrReplaceFile(
+                program.setFile(
                     {
                         src: change.pathAbsolute,
                         dest: rokuDeploy.getDestPath(change.pathAbsolute, options.files, rootDir)
@@ -864,7 +864,7 @@ export class LanguageServer {
             //sometimes "changed" events are emitted on files that were actually deleted,
             //so determine file existance and act accordingly
             if (await util.pathExists(change.pathAbsolute)) {
-                program.addOrReplaceFile(
+                program.setFile(
                     {
                         src: change.pathAbsolute,
                         dest: rokuDeploy.getDestPath(change.pathAbsolute, options.files, rootDir)
@@ -930,7 +930,7 @@ export class LanguageServer {
                     if (workspace.builder.program.hasFile(filePath)) {
                         let rootDir = workspace.builder.program.options.rootDir ?? workspace.builder.program.options.cwd;
                         let dest = rokuDeploy.getDestPath(filePath, workspace.builder.program.options.files, rootDir);
-                        workspace.builder.program.addOrReplaceFile({
+                        workspace.builder.program.setFile({
                             src: filePath,
                             dest: dest
                         }, documentText);