jupyterlab_vscode_icons_extension 1.2.2 → 1.2.6

package/README.md

@@ -25,6 +25,8 @@ This extension brings 1414 beautiful file type icons from the vscode-icons proje
 - Lightweight integration using Iconify's JSON icon format
 - Compatible with Jupytext - properly displays Python and Markdown icons for .py and .md notebook files; includes hotfix for jupytext 1.19.1 catch-all pattern bug that breaks standard file icons
 - Python package folder detection - folders declared in `pyproject.toml` or `setup.py` get a special Python package icon
+- Symbolic link badges - a link to a file or folder carries a small square arrow badge on its row icon
+- Executable file badges - an optional group, off by default, that marks files with the execute bit
 - Document tab icons matching the file browser - an open file carries the same glyph on its tab as on its row, and an icon another extension registered is kept rather than replaced
 - Readable on both themes - a glyph that cannot be seen against the panel it sits on is given a thin outline, decided per theme and re-decided when the theme changes
 
@@ -68,6 +70,7 @@ Customize which icon groups to display via JupyterLab Settings:
    - Configuration File Icons (Dockerfile, .gitignore, Makefile, package.json)
    - Documentation Icons (Markdown, RST, PDF)
    - Image File Icons (PNG, JPG, SVG)
+   - Executable File Icons (play badge on files with the execute bit; off by default)
 
 Changes require a page refresh to take effect.
 

package/lib/__tests__/activation.spec.js

@@ -46,7 +46,9 @@ const fakeApp = () => {
             return { dispose: () => undefined };
         },
         getFileTypesForPath: () => [],
-        getFileType: () => undefined
+        getFileType: () => undefined,
+        getFileTypeForModel: () => ({ name: 'text' }),
+        fileTypes: () => []
     };
     return {
         app: {
@@ -72,6 +74,28 @@ describe('activate without the optional services', () => {
         expect(registry.types.length).toBeGreaterThan(0);
         expect(registry.types.map(t => t.name)).toContain('vscode-file-type-js-official');
     });
+    // DEF-ICONS-49: one pattern covered CHANGELOG and CHANGELOG.md, so the
+    // markdown file was typed text/plain and drew the text-page glyph.
+    it('types CHANGELOG.md as markdown and the bare CHANGELOG as text', () => {
+        const { app, registry } = fakeApp();
+        plugin.activate(app, null, null);
+        const types = registry.types;
+        const claiming = (file) => types.filter(t => t.pattern && new RegExp(t.pattern).test(file));
+        const md = claiming('CHANGELOG.md');
+        expect(md.map(t => t.name)).toEqual(['vscode-changelog-md']);
+        expect(md[0].mimeTypes).toEqual(['text/markdown']);
+        expect(md[0].icon.name).toBe('ui-components:markdown');
+        const bare = claiming('CHANGELOG');
+        expect(bare.map(t => t.name)).toEqual(['vscode-changelog']);
+        expect(bare[0].mimeTypes).toEqual(['text/plain']);
+    });
+    // ACC-ICONS-36: an Arduino sketch is C++ source.
+    it('maps .ino to the C++ file type', () => {
+        const { app, registry } = fakeApp();
+        plugin.activate(app, null, null);
+        const cpp = registry.types.find(t => t.name === 'vscode-file-type-cpp');
+        expect(cpp.extensions).toContain('.ino');
+    });
     it('declares both services optional, which is what makes null legal', () => {
         var _a;
         expect(plugin.optional).toHaveLength(2);

package/lib/__tests__/artwork-geometry.spec.js

@@ -9,12 +9,13 @@
  */
 const source = require('fs').readFileSync(require('path').join(__dirname, '..', 'index.ts'), 'utf8');
 describe('the markdown M', () => {
-    // Two reductions of ten percent each, on his instruction: 1 -> 0.9 -> 0.81.
+    // Two earlier ten percent reductions, then twenty percent of the remaining
+    // height: 1 -> 0.9 -> 0.81 -> 0.648.
     // The transform scales about y=0, so a translate of baseline * (1 - scale)
     // puts the baseline back where it was and the letter loses height from the
     // top only. The M's baseline is the lowest coordinate in its own path data.
     const BASELINE = 189.5437;
-    const SCALE = 0.81;
+    const SCALE = 0.648;
     const transform = () => {
         const match = source.match(/<path fill="#8a2ea5" transform="translate\(0,([0-9.]+)\) scale\(1,([0-9.]+)\)"/);
         if (!match) {
@@ -22,7 +23,7 @@ describe('the markdown M', () => {
         }
         return { translate: Number(match[1]), scale: Number(match[2]) };
     };
-    it('is scaled to 81 percent of the height it was drawn at', () => {
+    it('is twenty percent shorter than the previous 81 percent height', () => {
         expect(transform().scale).toBeCloseTo(SCALE, 6);
     });
     it('keeps its baseline where the unscaled letter put it', () => {

package/lib/__tests__/manifest-validation.spec.d.ts

@@ -0,0 +1,10 @@
+/**
+ * Manifest validation before package name extraction - DEF-ICONS-55.
+ *
+ * ACC-PYPKG-17 promises that a malformed pyproject.toml or setup.py leaves
+ * every folder with its normal icon. The local parsers are regexes and still
+ * take a name out of a manifest that does not parse, so the source goes to
+ * the server's validation route first and an invalid answer drops the names.
+ * A failed call - the frontend-only install has no route - keeps them.
+ */
+export {};

package/lib/__tests__/manifest-validation.spec.js

@@ -0,0 +1,92 @@
+/**
+ * Manifest validation before package name extraction - DEF-ICONS-55.
+ *
+ * ACC-PYPKG-17 promises that a malformed pyproject.toml or setup.py leaves
+ * every folder with its normal icon. The local parsers are regexes and still
+ * take a name out of a manifest that does not parse, so the source goes to
+ * the server's validation route first and an invalid answer drops the names.
+ * A failed call - the frontend-only install has no route - keeps them.
+ */
+jest.mock('@jupyterlab/settingregistry', () => ({
+    ISettingRegistry: { name: 'ISettingRegistry' }
+}));
+jest.mock('@jupyterlab/filebrowser', () => ({
+    IDefaultFileBrowser: { name: 'IDefaultFileBrowser' }
+}));
+jest.mock('@jupyterlab/services', () => ({
+    ServerConnection: {
+        makeSettings: () => ({ baseUrl: '/' }),
+        makeRequest: jest.fn()
+    }
+}));
+jest.mock('@jupyterlab/ui-components', () => ({
+    LabIcon: class {
+        constructor(options) {
+            this.name = options.name;
+            this.svgstr = options.svgstr;
+        }
+        element() {
+            return document.createElement('div');
+        }
+    },
+    fileIcon: { name: 'ui-components:file' },
+    markdownIcon: { name: 'ui-components:markdown' }
+}));
+import { ServerConnection } from '@jupyterlab/services';
+import { packageNamesFromManifest } from '../index';
+import { parsePyprojectToml, parseSetupPy } from '../parsers';
+const makeRequest = ServerConnection.makeRequest;
+const answer = (valid) => {
+    makeRequest.mockResolvedValue({
+        ok: true,
+        json: async () => ({ valid })
+    });
+};
+describe('packageNamesFromManifest', () => {
+    beforeEach(() => {
+        makeRequest.mockReset();
+    });
+    it('adds no name a malformed pyproject.toml would otherwise contribute', async () => {
+        // The name line is complete; the unterminated string after it breaks the
+        // document, and the local regex takes the name anyway.
+        const source = '[project]\nname = "sample"\ninvalid = [\n';
+        expect(parsePyprojectToml(source).size).toBeGreaterThan(0);
+        answer(false);
+        expect(await packageNamesFromManifest(source, 'toml')).toEqual(new Set());
+    });
+    it('adds no name a truncated setup.py would otherwise contribute', async () => {
+        // The closure of setup() is missing, so the file is not valid Python; the
+        // local regex still finds the name.
+        const source = 'setup(name="sample"';
+        expect(parseSetupPy(source).size).toBeGreaterThan(0);
+        answer(false);
+        expect(await packageNamesFromManifest(source, 'python')).toEqual(new Set());
+    });
+    it('posts the source to the validation route and keeps a valid answer', async () => {
+        const source = '[project]\nname = "my-package"\n';
+        answer(true);
+        const names = await packageNamesFromManifest(source, 'toml');
+        expect(makeRequest).toHaveBeenCalledWith('/vscode-icons/validate-manifest', expect.objectContaining({
+            method: 'POST',
+            body: JSON.stringify({ kind: 'toml', source })
+        }), expect.anything());
+        expect(names.has('my-package')).toBe(true);
+    });
+    it('keeps the local names when the route is absent', async () => {
+        // A frontend-only install has no server half: the call 404s and the
+        // local parse stands, silently, as it did before the validation existed.
+        const source = '[project]\nname = "my-package"\n';
+        makeRequest.mockResolvedValue({
+            ok: false,
+            json: async () => ({})
+        });
+        const names = await packageNamesFromManifest(source, 'toml');
+        expect(names.has('my-package')).toBe(true);
+    });
+    it('keeps the local names when the call cannot complete', async () => {
+        const source = 'setup(name="my-package")';
+        makeRequest.mockRejectedValue(new Error('network'));
+        const names = await packageNamesFromManifest(source, 'python');
+        expect(names.has('my-package')).toBe(true);
+    });
+});

package/lib/__tests__/settings-alert.spec.js

@@ -39,7 +39,9 @@ const harness = async () => {
         docRegistry: {
             addFileType: () => ({ dispose: () => undefined }),
             getFileTypesForPath: () => [],
-            getFileType: () => undefined
+            getFileType: () => undefined,
+            getFileTypeForModel: () => ({ name: 'text' }),
+            fileTypes: () => []
         },
         shell: { add: () => undefined, currentWidget: null },
         commands: { addCommand: () => undefined },

package/lib/__tests__/settings-schema.spec.d.ts

@@ -2,7 +2,6 @@
  * Settings schema defaults - ACC-CONFIG-5.
  *
  * The seven toggles gate which icon groups paint. Six default on; executable
- * icons default off because detecting them costs a server round trip per
- * directory.
+ * icons default off per ACC-CONFIG-5.
  */
 export {};

package/lib/__tests__/settings-schema.spec.js

@@ -2,8 +2,7 @@
  * Settings schema defaults - ACC-CONFIG-5.
  *
  * The seven toggles gate which icon groups paint. Six default on; executable
- * icons default off because detecting them costs a server round trip per
- * directory.
+ * icons default off per ACC-CONFIG-5.
  */
 import schema from '../../schema/plugin.json';
 const properties = schema.properties;

package/lib/index.d.ts

@@ -1,3 +1,4 @@
 import { JupyterFrontEndPlugin } from '@jupyterlab/application';
+export declare function packageNamesFromManifest(source: string, kind: 'toml' | 'python', cacheKey?: string): Promise<Set<string>>;
 declare const plugin: JupyterFrontEndPlugin<void>;
 export default plugin;