Issue #25: Do not sort intermediate uses sections (#37)

* Only consider uses sections that follow and implementation, interface or program definition.

* Allow for comment blocks before uses section.

* fix spaces

* add more specific tests for matching only whole 'uses' keyword

* switch to ES2022

* fix tests:
* close opened editors
* run each test sequentially as we are interacting with the "active" editor of vscode

* fix test

* remove uses keyword in the comment, there is a bug affecting the process.

* update version

---------

Co-authored-by: Dave.Weij <Dave.Weij@bentley.com>
Co-authored-by: Tunç Bahçecioğlu <tunc.bahcecioglu@gmail.com>

Author: 3 people

package.json

@@ -2,7 +2,7 @@
   "name": "pascal-uses-formatter",
   "displayName": "pascal-uses-formatter",
   "description": "sorts the uses section in pascal files",
-  "version": "0.3.2",
+  "version": "0.3.3",
   "publisher": "tuncb",
   "repository": "https://github.com/tuncb/delphi-uses-formatter",
   "license": "Apache-2.0",

src/test/suite/extension.test.ts

@@ -1,32 +1,29 @@
-import { assert } from 'chai';
+import { assert, expect } from 'chai';
 import { before } from 'mocha';
 import * as path from 'path';
 import * as vscode from 'vscode';
 import glob = require('glob');
 
 const findCorrectFileName = (originalFileName: string) => {
   const originalPos = originalFileName.lastIndexOf('.original');
-  return `${originalFileName.substr(0, originalPos)}.correct.test.pas`;
+  return `${originalFileName.substring(0, originalPos)}.correct.test.pas`;
 };
 
 interface ITestPairDoc {
   originalDoc: vscode.TextDocument;
   correctDoc: vscode.TextDocument;
 }
 
-const openTextDocument = async (fileName: string): Promise<vscode.TextDocument> => {
-  return Promise.resolve(vscode.workspace.openTextDocument(fileName));
-};
-
 const openTestPair = async (originalFileName: string, correctFileName: string): Promise<ITestPairDoc> => {
-  const originalDoc = await openTextDocument(originalFileName);
-  const correctDoc = await openTextDocument(correctFileName);
+  const originalDoc = await vscode.workspace.openTextDocument(originalFileName);
+  const correctDoc = await vscode.workspace.openTextDocument(correctFileName);
 
-  return {originalDoc, correctDoc};
+  return { originalDoc, correctDoc };
 };
 
 const testFile = async (originalFileName: string): Promise<void> => {
   const correctFileName = findCorrectFileName(originalFileName);
+  console.log(originalFileName, correctFileName);
   const testPair = await openTestPair(originalFileName, correctFileName);
   await vscode.window.showTextDocument(testPair.originalDoc);
 
@@ -39,7 +36,10 @@ const testFile = async (originalFileName: string): Promise<void> => {
   const changedText = testPair.originalDoc.getText();
   const correctDoc = testPair.correctDoc.getText();
 
-  assert.ok(correctDoc === changedText);
+  expect(changedText).to.equal(correctDoc);
+
+  await vscode.commands.executeCommand('workbench.action.revertAndCloseActiveEditor');
+  await vscode.commands.executeCommand('workbench.action.closeAllEditors');
 };
 
 suite('Extension Test Suite', () => {
@@ -50,6 +50,8 @@ suite('Extension Test Suite', () => {
   test('Conversion tests', async () => {
     const fileGlob = path.resolve(__dirname, '../../../testExamples', '*.original.test.pas');
     const files = glob.sync(fileGlob);
-    return Promise.all(files.map(testFile));
+    for (const file of files) {
+      await testFile(file);
+    }
   });
 });

src/test/suite/usesFormatter.test.ts

@@ -1,7 +1,7 @@
 import { formatText, ITextSection } from '../../usesFormatter';
 
 var expect = require('chai').expect;
-var {describe, it} = require('mocha');
+var { describe, it } = require('mocha');
 
 interface ITestInput {
   text: string;
@@ -22,7 +22,7 @@ const sampleTexts: TestSample[] = [
     output: [
       {
         startOffset: 0,
-        endOffset:22,
+        endOffset: 22,
         value: "uses\n  a,\n  b,\n  c,\n  d,\n  e,\n  f;"
       }
     ],
@@ -35,26 +35,45 @@ const sampleTexts: TestSample[] = [
     output: [
       {
         startOffset: 0,
-        endOffset:22,
+        endOffset: 22,
         value: "uses\n  c,\n  f,\n  a,\n  b,\n  d,\n  e;"
       }
     ],
   },
+  {
+    input: {
+      text: "}uses d, c, b, e, f, a;",
+      configurableSortingArray: ["c", "f"]
+    },
+    output: [
+      {
+        startOffset: 1,
+        endOffset: 23,
+        value: "uses\n  c,\n  f,\n  a,\n  b,\n  d,\n  e;"
+      }
+    ],
+  },
+  {
+    input: {
+      text: "kuses d, c, b, e, f, a;",
+      configurableSortingArray: ["c", "f"]
+    },
+    output: [],
+  },
 
 ];
 
-const test = (sample: TestSample): void =>
-{
+const test = (sample: TestSample): void => {
   const separator = "  ";
   const lineEnd = "\n";
 
   const replaces = formatText(sample.input.text, separator, lineEnd, sample.input.configurableSortingArray);
   expect(replaces).to.eql(sample.output);
 };
 
-describe('UsesFormatter', function() {
+describe('UsesFormatter', function () {
   describe('formatText', function () {
-    it('Expect correct  replaceText for provided  samples',  function() {
+    it('Expect correct  replaceText for provided  samples', function () {
       sampleTexts.forEach(test);
     });
   });

src/usesFormatter.ts

@@ -4,42 +4,41 @@ export interface ITextSection {
   value: string;
 }
 
-const findUsesSections = (text: string): ITextSection[]  => {
-  const regex = /uses[\s\w.,]+;/g;
+const findUsesSections = (text: string): ITextSection[] => {
+  const regex = /(?:^|[\s}])(uses[\s\w.,]+;)/gid;
   const results: ITextSection[] = [];
   let match = null;
   while ((match = regex.exec(text)) !== null) {
     results.push({
-      startOffset: match.index,
+      startOffset: match.index + match[0].length - match[1].length,
       endOffset: match.index + match[0].length,
-      value: match[0]
+      value: match[1]
     });
   }
   return results;
 };
 
-const parseUnits = (text:string): string[] => {
+const parseUnits = (text: string): string[] => {
   return text
     .substring(4, text.length - 1)
-    .replace(/(\r\n\t|\n|\r\t|\s)/gm,"")
+    .replace(/(\r\n\t|\n|\r\t|\s)/gm, "")
     .split(',');
 };
 
-function formatUsesSection(units: string[], separator: string, lineEnd: string, configurableSortingArray: string[]): string
-{
+function formatUsesSection(units: string[], separator: string, lineEnd: string, configurableSortingArray: string[]): string {
   const sortFun = (a: string, b: string) => {
-    for(let namespace of configurableSortingArray){
-        let normalizedNamespace = namespace.toLowerCase();
-        let normalizedA = a.trim().toLocaleLowerCase();
-        let normalizedB = b.trim().toLocaleLowerCase();
-        if(normalizedA.startsWith(normalizedNamespace) && !normalizedB.startsWith(normalizedNamespace)){
-            return -1;
-        }
-        else if(!normalizedA.startsWith(normalizedNamespace) && normalizedB.startsWith(normalizedNamespace)){
-            return 1;
-        }
+    for (let namespace of configurableSortingArray) {
+      let normalizedNamespace = namespace.toLowerCase();
+      let normalizedA = a.trim().toLocaleLowerCase();
+      let normalizedB = b.trim().toLocaleLowerCase();
+      if (normalizedA.startsWith(normalizedNamespace) && !normalizedB.startsWith(normalizedNamespace)) {
+        return -1;
+      }
+      else if (!normalizedA.startsWith(normalizedNamespace) && normalizedB.startsWith(normalizedNamespace)) {
+        return 1;
+      }
     }
-    return a.localeCompare(b, undefined, {sensitivity: 'base'});
+    return a.localeCompare(b, undefined, { sensitivity: 'base' });
   };
 
   const formattedUnits = units.sort(sortFun).join(`,${lineEnd}${separator}`);
@@ -51,7 +50,7 @@ export function formatText(text: string, separator: string, lineEnd: string, con
     return {
       startOffset: section.startOffset,
       endOffset: section.endOffset,
-      value: formatUsesSection(parseUnits(section.value),  separator, lineEnd, configurableSortingArray)
+      value: formatUsesSection(parseUnits(section.value), separator, lineEnd, configurableSortingArray)
     };
   });
 }

testExamples/ex2.correct.test.pas

@@ -0,0 +1,57 @@
+unit ex2;
+
+interface
+
+uses
+  b,
+  c,
+  f,
+  f,
+  g,
+  h,
+  k,
+  l,
+  t,
+  u,
+  y;
+
+// will not be sorted due to extra k in front
+implementation
+kuses
+  b,
+  c,
+  f,
+  f,
+  z,
+  g,
+  h,
+  k,
+  l,
+  t,
+  u,
+  y;
+
+{ Will be sorted, uses is preceded by comment block or compiler directive
+}uses
+  Generics.Collections.patched,
+  MemoryGuard,
+  Optional,
+  ProjectDB.DelphiFacade.FacadeManagedDataView,
+  ProjectDB.DelphiFacade.FacadeManagedDataViewFactory,
+  ProjectDB.DelphiFacade.FMDMeshEntityComponentData,
+  ProjectDB.DelphiFacade.FMDMeshEntityResultData,
+  ProjectDB.DelphiFacade.FMDNodeCoordinates,
+  ProjectDB.DelphiFacade.FMOMesh,
+  ProjectDB.DelphiFacade.FMOMeshEntity,
+  ProjectDB.DelphiFacade.FMOMeshEntityPhasesState,
+  ProjectDB.DelphiFacade.FMOPhase,
+  ProjectDB.DelphiFacade.FMOStep,
+  System.SysUtils,
+  Xvtkwc.DataArray,
+  Xvtkwc.Definitions,
+  Xvtkwc.DllLoader,
+  Xvtkwc.Piece,
+  Xvtkwc.PvdItem,
+  Xvtkwc.Writer;
+
+end.

testExamples/ex2.original.test.pas

@@ -0,0 +1,57 @@
+unit ex2;
+
+interface
+
+uses
+  b,
+  c,
+  f,
+  f,
+  g,
+  h,
+  k,
+  l,
+  t,
+  u,
+  y;
+
+// will not be sorted due to extra k in front
+implementation
+kuses
+  b,
+  c,
+  f,
+  f,
+  z,
+  g,
+  h,
+  k,
+  l,
+  t,
+  u,
+  y;
+
+{ Will be sorted, uses is preceded by comment block or compiler directive
+}uses
+  ProjectDB.DelphiFacade.FMDMeshEntityResultData,
+  ProjectDB.DelphiFacade.FMDNodeCoordinates,
+  ProjectDB.DelphiFacade.FMOMesh,
+  ProjectDB.DelphiFacade.FMOMeshEntity,
+  ProjectDB.DelphiFacade.FMOMeshEntityPhasesState,
+  ProjectDB.DelphiFacade.FMOPhase,
+  ProjectDB.DelphiFacade.FMOStep,
+  ProjectDB.DelphiFacade.FacadeManagedDataView,
+  ProjectDB.DelphiFacade.FacadeManagedDataViewFactory,
+  System.SysUtils,
+  Xvtkwc.DataArray,
+  Xvtkwc.Definitions,
+  Xvtkwc.DllLoader,
+  Generics.Collections.patched,
+  MemoryGuard,
+  Optional,
+  ProjectDB.DelphiFacade.FMDMeshEntityComponentData,
+  Xvtkwc.Piece,
+  Xvtkwc.PvdItem,
+  Xvtkwc.Writer;
+
+end.

tsconfig.json

@@ -1,23 +1,23 @@
 {
-    "compilerOptions": {
-        "module": "commonjs",
-        "target": "es6",
-        "outDir": "out",
-        "lib": [
-            "es6"
-        ],
-        "sourceMap": true,
-        "rootDir": "src",
-        /* Strict Type-Checking Option */
-        "strict": true,   /* enable all strict type-checking options */
-        /* Additional Checks */
-        "noUnusedLocals": true /* Report errors on unused locals. */
-        // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
-        // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
-        // "noUnusedParameters": true,  /* Report errors on unused parameters. */
-    },
-    "exclude": [
-        "node_modules",
-        ".vscode-test"
-    ]
+  "compilerOptions": {
+    "module": "commonjs",
+    "target": "ES2022",
+    "outDir": "out",
+    "lib": [
+      "ES2022"
+    ],
+    "sourceMap": true,
+    "rootDir": "src",
+    /* Strict Type-Checking Option */
+    "strict": true, /* enable all strict type-checking options */
+    /* Additional Checks */
+    "noUnusedLocals": true /* Report errors on unused locals. */
+    // "noImplicitReturns": true, /* Report error when not all code paths in function return a value. */
+    // "noFallthroughCasesInSwitch": true, /* Report errors for fallthrough cases in switch statement. */
+    // "noUnusedParameters": true,  /* Report errors on unused parameters. */
+  },
+  "exclude": [
+    "node_modules",
+    ".vscode-test"
+  ]
 }