@nuxt/devtools-wizard-nightly 2.0.0-beta.0-28940159.3b2c84c

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022-PRESENT Nuxt Team
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,129 @@
+<a href="https://devtools.nuxt.com"><img width="1200" alt="Nuxt DevTools" src="https://github-production-user-asset-6210df.s3.amazonaws.com/904724/261577617-a10567bd-ad33-48cc-9bda-9e37dbe1929f.png"></a>
+<br>
+
+<h1>
+Nuxt DevTools
+</h1>
+
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+[![Nuxt][nuxt-src]][nuxt-href]
+[![Volta][volta-src]][volta-href]
+
+<p>
+Unleash Nuxt Developer Experience.
+<br>Nuxt DevTools is a set of visual tools that help you to know your app better.
+</p>
+
+<p>
+  <a href="https://nuxt.com/blog/nuxt-devtools-v1-0">👋 Introduction</a> |
+  <a href="https://github.com/nuxt/devtools/discussions/29">💡 Ideas & Suggestions</a> |
+  <a href="https://github.com/nuxt/devtools/discussions/31">🗺️ Project Roadmap</a> |
+  <a href="https://devtools.nuxt.com/">📚 Documentation</a>
+</p>
+
+<br>
+
+> [!NOTE]
+> You are viewing the v2.x branch which are in active development. For the latest stable version, please refer to the [v1.x branch](https://github.com/nuxt/devtools/tree/v1)
+
+## Installation
+
+> Nuxt DevTools v2 requires **Nuxt v3.15.0 or higher**.
+
+Nuxt DevTools is **enabled by default** in Nuxt v3.8.0. You can press <kbd>Shift</kbd> + <kbd>Alt</kbd> / <kbd>⇧ Shift</kbd> + <kbd>⌥ Option</kbd> + <kbd>D</kbd> in your app to open it up.
+
+If you want to explicitly enable or disable Nuxt DevTools, you can update your `nuxt.config` with:
+
+```js
+export default defineNuxtConfig({
+  devtools: {
+    enabled: true // or false to disable
+  }
+})
+```
+
+### Nightly Release Channel
+
+Similar to [Nuxt's Nightly Channel](https://nuxt.com/docs/guide/going-further/nightly-release-channel), DevTools also offers a nightly release channel, that automatically releases for every commit to `main` branch.
+
+You can opt-in to the nightly release channel by running:
+
+```diff
+{
+  "devDependencies": {
+--    "@nuxt/devtools": "^0.1.0"
+++    "@nuxt/devtools": "npm:@nuxt/devtools-nightly@latest"
+  }
+}
+```
+
+Remove lockfile (`package-lock.json`, `yarn.lock`, or `pnpm-lock.yaml`) and reinstall dependencies.
+
+### Module Options
+
+To configure Nuxt DevTools, you can pass the `devtools` options.
+
+```ts
+// nuxt.config.ts
+export default defineNuxtConfig({
+  devtools: {
+    // Enable devtools (default: true)
+    enabled: true,
+    // VS Code Server options
+    vscode: {},
+    // ...other options
+  }
+})
+```
+
+For all options available, please refer to TSDocs in your IDE, or the [type definition file](https://github.com/nuxt/devtools/blob/main/packages/devtools-kit/src/_types/options.ts).
+
+## Features
+
+Read the [**Announcement Blog Post 🎊**](https://nuxt.com/blog/nuxt-devtools-v1-0) for why we built Nuxt DevTools and what it can do!
+
+## Module Authors
+
+Please refer to the [Module Authors Guide](https://devtools.nuxt.com/module/guide).
+
+## Contribution Guide
+
+Please refer to the [Contribution Guide](https://devtools.nuxt.com/development/contributing).
+
+## Anonymous Usage Analytics
+
+Nuxt DevTools collects anonymous telemetry data about general usage. This helps us to accurately gauge feature usage and customization across all our users. This data will let us better understand how each features in Nuxt DevTools are used, measuring improvements made (DX and performances) and their relevance. It would also help us to prioritize our efforts and focus on the features that matter the most to our users.
+
+Nuxt DevTools' telemetry data is piped through [Nuxt Telemetry](https://github.com/nuxt/telemetry), meaning that Nuxt DevTools will respect your local and global Nuxt Telemetry settings. You can also opt-out Nuxt DevTools' telemetry in the Nuxt DevTools settings.
+
+The data we collect is completely anonymous, not traceable to the source (using hash+seed), and only meaningful in aggregate form. No data we collect is personally identifiable or trackable.
+
+### Events
+
+On top of the [default Nuxt Telemetry events](https://github.com/nuxt/telemetry#events), Nuxt DevTools also collects the following events:
+
+- Versions of Nuxt DevTools
+- Navigations between tabs/feature
+  - This helps us to understand which features are used the most to prioritize our efforts.
+- Browser and OS names and versions
+  - This helps us improve compatibility across different browsers and operating systems.
+- Click event on some action buttons
+
+## License
+
+[MIT](./LICENSE)
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@nuxt/devtools/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@nuxt/devtools
+[npm-downloads-src]: https://img.shields.io/npm/dm/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npm.chart.dev/@nuxt/devtools
+[license-src]: https://img.shields.io/npm/l/@nuxt/devtools.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@nuxt/devtools
+[nuxt-src]: https://img.shields.io/badge/Nuxt-18181B?logo=nuxt.js
+[nuxt-href]: https://nuxt.com
+[volta-src]: https://user-images.githubusercontent.com/904724/209143798-32345f6c-3cf8-4e06-9659-f4ace4a6acde.svg
+[volta-href]: https://volta.net/nuxt/devtools?utm_source=nuxt_devtools_readme

package/cli.mjs

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import('./dist/index.mjs')

package/dist/chunks/builtin.mjs

@@ -0,0 +1,109 @@
+import { existsSync } from 'node:fs';
+import fsp from 'node:fs/promises';
+import { relative } from 'node:path';
+import { consola } from 'consola';
+import { colors } from 'consola/utils';
+import { diffLines } from 'diff';
+import { parseModule } from 'magicast';
+import { join } from 'pathe';
+import prompts from 'prompts';
+
+function findNuxtConfig(cwd) {
+  const names = [
+    "nuxt.config.ts",
+    "nuxt.config.js"
+  ];
+  for (const name of names) {
+    const path = join(cwd, name);
+    if (existsSync(path))
+      return path;
+  }
+}
+function printOutManual(value) {
+  consola.info(colors.yellow("To manually enable Nuxt DevTools, add the following to your Nuxt config:"));
+  consola.info(colors.cyan(`
+  devtools: { enabled: ${value} }
+`));
+}
+async function toggleConfig(cwd, value) {
+  const nuxtConfig = findNuxtConfig(cwd);
+  if (!nuxtConfig) {
+    consola.error(colors.red("Unable to find Nuxt config file in current directory"));
+    process.exitCode = 1;
+    printOutManual(true);
+    return false;
+  }
+  try {
+    const source = await fsp.readFile(nuxtConfig, "utf-8");
+    const mod = await parseModule(source, { sourceFileName: nuxtConfig });
+    const config = mod.exports.default.$type === "function-call" ? mod.exports.default.$args[0] : mod.exports.default;
+    if (config.devtools || value) {
+      config.devtools ||= {};
+      if (typeof config.devtools === "object")
+        config.devtools.enabled = value;
+    }
+    const generated = mod.generate().code;
+    if (source.trim() === generated.trim()) {
+      consola.info(colors.yellow(`Nuxt DevTools is already ${value ? "enabled" : "disabled"}`));
+    } else {
+      consola.log("");
+      consola.log("We are going to update the Nuxt config with with the following changes:");
+      consola.log(colors.bold(colors.green(`./${relative(cwd, nuxtConfig)}`)));
+      consola.log("");
+      printDiffToCLI(source, generated);
+      consola.log("");
+      const { confirm } = await prompts({
+        type: "confirm",
+        name: "confirm",
+        message: "Continue?",
+        initial: true
+      });
+      if (!confirm)
+        return false;
+      await fsp.writeFile(nuxtConfig, `${generated.trimEnd()}
+`, "utf-8");
+    }
+  } catch {
+    consola.error(colors.red("Unable to update Nuxt config file automatically"));
+    process.exitCode = 1;
+    printOutManual(true);
+    return false;
+  }
+  return true;
+}
+async function enable(cwd) {
+  if (await toggleConfig(cwd, true)) {
+    await import('./global.mjs').then((r) => r.disableSilently(cwd));
+    consola.success(colors.green("Nuxt DevTools is enabled! Restart your Nuxt app to start using it."));
+  }
+}
+async function disable(cwd) {
+  if (await toggleConfig(cwd, false)) {
+    await import('./global.mjs').then((r) => r.disableSilently(cwd));
+    consola.success("Nuxt DevTools disabled for this project.");
+  }
+}
+function printDiffToCLI(from, to) {
+  const diffs = diffLines(from.trim(), to.trim());
+  let output = "";
+  let no = 0;
+  for (const diff of diffs) {
+    const lines = diff.value.trimEnd().split("\n");
+    for (const line of lines) {
+      if (!diff.added)
+        no += 1;
+      if (diff.added)
+        output += colors.green(`+    | ${line}
+`);
+      else if (diff.removed)
+        output += colors.red(`-${no.toString().padStart(3, " ")} | ${line}
+`);
+      else
+        output += colors.gray(`${colors.dim(`${no.toString().padStart(4, " ")} |`)} ${line}
+`);
+    }
+  }
+  consola.log(output.trimEnd());
+}
+
+export { disable, enable };

package/dist/chunks/global.mjs

@@ -0,0 +1,67 @@
+import fs from 'node:fs';
+import { consola } from 'consola';
+import { execa } from 'execa';
+import globalDirs from 'global-directory';
+import { resolve } from 'pathe';
+import { readUser, writeUser } from 'rc9';
+
+const moduleName = "@nuxt/devtools";
+const RC_PATH = ".nuxtrc";
+const pathRegex = /[\\/]@nuxt[\\/]devtools[\\/]/;
+async function enable(cwd) {
+  const rc = readUser(RC_PATH);
+  consola.info("Installed Nuxt DevTools...");
+  await execa("npm", ["install", "-g", `${moduleName}@latest`], { stdio: "inherit" });
+  markEnable(rc, cwd);
+  consola.info("Nuxt DevTools enabled! Restart your Nuxt app to start using it.");
+}
+function markEnable(rc, path) {
+  const modulePath = resolve(globalDirs.npm.packages, moduleName);
+  const targetPath = resolve(modulePath, "module.cjs").replace(/\\/g, "/");
+  if (!fs.existsSync(targetPath))
+    throw new Error("Failed to locate the global Nuxt DevTools module. You may try it again");
+  removeModule(rc);
+  if (!rc.modules?.includes(targetPath))
+    rc.modules = [...rc.modules || [], targetPath];
+  if (!rc.devtoolsGlobal)
+    rc.devtoolsGlobal = {};
+  if (!rc.devtoolsGlobal.projects)
+    rc.devtoolsGlobal.projects = [];
+  if (!rc.devtoolsGlobal.projects.includes(path))
+    rc.devtoolsGlobal.projects.push(path);
+  writeUser(rc, RC_PATH);
+}
+function disableSilently(cwd) {
+  const rc = readUser(RC_PATH);
+  if (markDisable(rc, cwd))
+    writeUser(rc, RC_PATH);
+}
+async function disable(cwd, args) {
+  const rc = readUser(RC_PATH);
+  const isRemove = args.includes("--remove");
+  if (markDisable(rc, cwd))
+    consola.success("Nuxt DevTools disabled for this project.");
+  else if (!isRemove)
+    consola.warn("Nuxt DevTools is not enabled for this project.");
+  if (isRemove) {
+    removeModule(rc);
+    consola.success("Nuxt DevTools is removed globally");
+  }
+  writeUser(rc, RC_PATH);
+}
+function markDisable(rc, path) {
+  if (rc?.devtoolsGlobal?.projects?.includes(path)) {
+    rc.devtoolsGlobal.projects = rc.devtoolsGlobal.projects.filter((p) => p !== path);
+    return true;
+  }
+  if (!rc?.devtoolsGlobal?.projects?.length)
+    removeModule(rc);
+  return false;
+}
+function removeModule(rc) {
+  if (Array.isArray(rc.modules))
+    rc.modules = rc.modules.filter((p) => !p.match(pathRegex));
+  return true;
+}
+
+export { RC_PATH, disable, disableSilently, enable, removeModule };

package/dist/index.mjs

@@ -0,0 +1,59 @@
+import { consola } from 'consola';
+import { colors } from 'consola/utils';
+import { readPackageJSON } from 'pkg-types';
+import semver from 'semver';
+
+const name = "@nuxt/devtools-wizard-nightly";
+const version = "2.0.0-beta.0-28940159.3b2c84c";
+
+async function getNuxtVersion(path) {
+  try {
+    const pkg = await readPackageJSON("nuxt", { url: path });
+    if (!pkg.version)
+      consola.warn("Cannot find any installed nuxt versions in ", path);
+    return pkg.version || null;
+  } catch {
+    return null;
+  }
+}
+async function run() {
+  const args = process.argv.slice(2);
+  const command = args[0];
+  const cwd = process.cwd();
+  consola.log("");
+  consola.log(colors.bold(colors.green(" Nuxt ")));
+  consola.log(`${colors.inverse(colors.bold(colors.green(" DevTools ")))} ${colors.green(`v${version}`)}`);
+  consola.log(`
+${colors.gray("Learn more at https://devtools.nuxt.com\n")}`);
+  if (name.endsWith("-edge") || name.endsWith("-nightly"))
+    throw new Error("Nightly release of Nuxt DevTools requires to be installed locally. Learn more at https://github.com/nuxt/devtools/#nightly-release-channel");
+  const nuxtVersion = await getNuxtVersion(cwd);
+  if (!nuxtVersion) {
+    consola.error("Unable to find any installed nuxt version in the current directory");
+    process.exit(1);
+  }
+  const isDevToolsBuiltIn = semver.gte(nuxtVersion, "3.4.0");
+  if (command === "enable") {
+    consola.log(colors.green("Enabling Nuxt DevTools..."));
+    if (isDevToolsBuiltIn)
+      await import('./chunks/builtin.mjs').then((r) => r.enable(cwd));
+    else
+      await import('./chunks/global.mjs').then((r) => r.enable(cwd));
+  } else if (command === "disable") {
+    consola.log(colors.magenta("Disabling Nuxt DevTools..."));
+    if (isDevToolsBuiltIn)
+      await import('./chunks/builtin.mjs').then((r) => r.disable(cwd));
+    else
+      await import('./chunks/global.mjs').then((r) => r.disable(cwd, args));
+  } else if (!command) {
+    consola.log(`npx ${name} enable|disable`);
+    process.exit(1);
+  } else {
+    consola.log(colors.red(`Unknown command "${command}"`));
+    process.exit(1);
+  }
+}
+run().catch((err) => {
+  consola.error(err);
+  process.exit(1);
+});

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "@nuxt/devtools-wizard-nightly",
+  "type": "module",
+  "version": "2.0.0-beta.0-28940159.3b2c84c",
+  "description": "CLI Wizard to toggle Nuxt DevTools",
+  "license": "MIT",
+  "homepage": "https://devtools.nuxt.com",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/nuxt/devtools.git",
+    "directory": "packages/devtools-wizard"
+  },
+  "main": "./dist/index.mjs",
+  "bin": "./cli.mjs",
+  "files": [
+    "*.cjs",
+    "*.d.ts",
+    "*.mjs",
+    "dist"
+  ],
+  "dependencies": {
+    "consola": "^3.3.3",
+    "diff": "^7.0.0",
+    "execa": "^7.2.0",
+    "global-directory": "^4.0.1",
+    "magicast": "^0.3.5",
+    "pathe": "^2.0.0",
+    "pkg-types": "^1.3.0",
+    "prompts": "^2.4.2",
+    "rc9": "^2.1.2",
+    "semver": "^7.6.3"
+  },
+  "devDependencies": {
+    "@types/diff": "^7.0.0",
+    "@types/prompts": "^2.4.9",
+    "unbuild": "^3.2.0"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "stub": "unbuild --stub",
+    "dev:prepare": "nr stub"
+  }
+}