@lvce-editor/eslint-plugin-devcontainer 14.0.1

package/dist/index.js

@@ -0,0 +1,290 @@
+import json from '@eslint/json';
+import { existsSync, readFileSync } from 'node:fs';
+import { join } from 'node:path';
+
+const isObjectNode = node => {
+  return node && node.type === 'Object';
+};
+const isStringNode = node => {
+  return node && node.type === 'String';
+};
+const getMemberName = member => {
+  if (member.name.type === 'String') {
+    return member.name.value;
+  }
+  if (member.name.type === 'Identifier') {
+    return member.name.name;
+  }
+  return undefined;
+};
+const findMember = (node, name) => {
+  if (!isObjectNode(node)) {
+    return undefined;
+  }
+  for (const member of node.members) {
+    if (getMemberName(member) === name) {
+      return member;
+    }
+  }
+  return undefined;
+};
+
+const defaultAllowedImages = ['mcr.microsoft.com/devcontainers/javascript-node:24'];
+const meta$2 = {
+  docs: {
+    description: 'Ensure that the devcontainer image is allowed'
+  },
+  messages: {
+    imageMustBeString: 'devcontainer image must be a string',
+    missingImage: 'devcontainer image must be configured',
+    unsupportedImage: 'Unsupported devcontainer image: {{image}}'
+  },
+  schema: [{
+    additionalProperties: false,
+    properties: {
+      allowedImages: {
+        items: {
+          type: 'string'
+        },
+        type: 'array',
+        uniqueItems: true
+      }
+    },
+    type: 'object'
+  }],
+  type: 'problem'
+};
+const getAllowedImages = context => {
+  const [options] = context.options;
+  if (options && typeof options === 'object' && Array.isArray(options.allowedImages)) {
+    return options.allowedImages;
+  }
+  return defaultAllowedImages;
+};
+const create$2 = context => {
+  const allowedImages = new Set(getAllowedImages(context));
+  return {
+    Document(node) {
+      if (!isObjectNode(node.body)) {
+        context.report({
+          loc: node.loc,
+          messageId: 'missingImage'
+        });
+        return;
+      }
+      const image = findMember(node.body, 'image');
+      if (!image) {
+        context.report({
+          loc: node.body.loc,
+          messageId: 'missingImage'
+        });
+        return;
+      }
+      if (!isStringNode(image.value)) {
+        context.report({
+          loc: image.name.loc,
+          messageId: 'imageMustBeString'
+        });
+        return;
+      }
+      if (!allowedImages.has(image.value.value)) {
+        context.report({
+          data: {
+            image: image.value.value
+          },
+          loc: image.name.loc,
+          messageId: 'unsupportedImage'
+        });
+      }
+    }
+  };
+};
+
+const allowedImage = {
+  __proto__: null,
+  create: create$2,
+  defaultAllowedImages,
+  meta: meta$2
+};
+
+const expectedPostCreateCommand = 'npm ci';
+const playwrightInstallDepsPattern = /\bnpx\s+playwright\s+install-deps(?:\s|$|&&|;)/u;
+const playwrightInstallPattern = /\bnpx\s+playwright\s+install(?:\s|$|&&|;)/u;
+const dependencySections = ['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies'];
+const meta$1 = {
+  docs: {
+    description: 'Ensure that devcontainer postCreateCommand is configured correctly'
+  },
+  messages: {
+    invalidPostCreateCommand: 'devcontainer postCreateCommand must be npm ci',
+    missingPlaywrightPostinstall: 'packages/e2e/package.json postinstall must install Playwright dependencies',
+    missingPostCreateCommand: 'devcontainer postCreateCommand must be configured',
+    postCreateCommandMustBeString: 'devcontainer postCreateCommand must be a string'
+  },
+  type: 'problem'
+};
+const readJson = path => {
+  try {
+    return JSON.parse(readFileSync(path, 'utf8'));
+  } catch {
+    return undefined;
+  }
+};
+const hasPlaywrightDependency = packageJson => {
+  for (const section of dependencySections) {
+    const dependencies = packageJson[section];
+    if (!dependencies || typeof dependencies !== 'object') {
+      continue;
+    }
+    if ('playwright' in dependencies || '@playwright/test' in dependencies) {
+      return true;
+    }
+  }
+  return false;
+};
+const hasRequiredPlaywrightPostinstall = packageJson => {
+  const postinstall = packageJson.scripts?.postinstall;
+  if (typeof postinstall !== 'string') {
+    return false;
+  }
+  return playwrightInstallDepsPattern.test(postinstall) && playwrightInstallPattern.test(postinstall);
+};
+const shouldReportPlaywrightPostinstall = cwd => {
+  const packageJsonPath = join(cwd, 'packages', 'e2e', 'package.json');
+  if (!existsSync(packageJsonPath)) {
+    return false;
+  }
+  const packageJson = readJson(packageJsonPath);
+  if (!packageJson || !hasPlaywrightDependency(packageJson)) {
+    return false;
+  }
+  return !hasRequiredPlaywrightPostinstall(packageJson);
+};
+const create$1 = context => {
+  return {
+    Document(node) {
+      if (!isObjectNode(node.body)) {
+        context.report({
+          loc: node.loc,
+          messageId: 'missingPostCreateCommand'
+        });
+        return;
+      }
+      const postCreateCommand = findMember(node.body, 'postCreateCommand');
+      if (!postCreateCommand) {
+        context.report({
+          loc: node.body.loc,
+          messageId: 'missingPostCreateCommand'
+        });
+      } else if (!isStringNode(postCreateCommand.value)) {
+        context.report({
+          loc: postCreateCommand.name.loc,
+          messageId: 'postCreateCommandMustBeString'
+        });
+      } else if (postCreateCommand.value.value !== expectedPostCreateCommand) {
+        context.report({
+          loc: postCreateCommand.name.loc,
+          messageId: 'invalidPostCreateCommand'
+        });
+      }
+      if (shouldReportPlaywrightPostinstall(context.cwd)) {
+        context.report({
+          loc: node.body.loc,
+          messageId: 'missingPlaywrightPostinstall'
+        });
+      }
+    }
+  };
+};
+
+const postCreateCommand = {
+  __proto__: null,
+  create: create$1,
+  meta: meta$1
+};
+
+const desktopLiteFeature = 'ghcr.io/devcontainers/features/desktop-lite:1';
+const meta = {
+  docs: {
+    description: 'Ensure that the desktop-lite devcontainer feature is enabled'
+  },
+  messages: {
+    featuresMustBeObject: 'devcontainer features must be an object',
+    missingDesktopLiteFeature: 'desktop-lite devcontainer feature must be enabled',
+    missingFeatures: 'devcontainer features must be configured'
+  },
+  type: 'problem'
+};
+const create = context => {
+  return {
+    Document(node) {
+      if (!isObjectNode(node.body)) {
+        context.report({
+          loc: node.loc,
+          messageId: 'missingFeatures'
+        });
+        return;
+      }
+      const features = findMember(node.body, 'features');
+      if (!features) {
+        context.report({
+          loc: node.body.loc,
+          messageId: 'missingFeatures'
+        });
+        return;
+      }
+      if (!isObjectNode(features.value)) {
+        context.report({
+          loc: features.name.loc,
+          messageId: 'featuresMustBeObject'
+        });
+        return;
+      }
+      const feature = findMember(features.value, desktopLiteFeature);
+      if (!feature) {
+        context.report({
+          loc: features.name.loc,
+          messageId: 'missingDesktopLiteFeature'
+        });
+      }
+    }
+  };
+};
+
+const requireDesktopLiteFeature = {
+  __proto__: null,
+  create,
+  meta
+};
+
+const plugin = {
+  configs: {},
+  meta: {
+    name: 'devcontainer',
+    version: '0.0.1'
+  },
+  rules: {
+    'allowed-image': allowedImage,
+    'post-create-command': postCreateCommand,
+    'require-desktop-lite-feature': requireDesktopLiteFeature
+  }
+};
+const recommended = [{
+  files: ['**/.devcontainer/devcontainer.json'],
+  language: 'json/jsonc',
+  languageOptions: {
+    allowTrailingCommas: true
+  },
+  plugins: {
+    devcontainer: plugin,
+    // @ts-ignore
+    json
+  },
+  rules: {
+    'devcontainer/allowed-image': 'error',
+    'devcontainer/post-create-command': 'error',
+    'devcontainer/require-desktop-lite-feature': 'error'
+  }
+}];
+
+export { recommended as default };

package/package.json

@@ -0,0 +1,15 @@
+{
+  "name": "@lvce-editor/eslint-plugin-devcontainer",
+  "version": "14.0.1",
+  "main": "dist/index.js",
+  "type": "module",
+  "license": "MIT",
+  "description": "ESLint rules for devcontainer configuration files.",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/lvce-editor/eslint-config.git"
+  },
+  "dependencies": {
+    "@eslint/json": "2.0.0"
+  }
+}