@uni-helper/uni-env 0.0.1

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 KeJun <https://github.com/kejunmao>
+
+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,32 @@
+# @uni-helper/uni-env
+
+> 检测当前 uni-app 的环境变量
+
+## 安装
+
+```sh
+# Using Yarn
+yarn add @uni-helper/uni-env
+
+# Using npm
+npm i @uni-helper/uni-env
+
+# Using pnpm
+pnpm i @uni-helper/uni-env
+```
+
+## 使用
+
+```js
+// ESM
+import { isMpWeixin } from "@uni-helper/uni-env";
+
+// CommonJS
+const { isMp } = require("@uni-helper/uni-env");
+```
+
+你可以从 [./src/index.ts](./src/index.ts) 中查看更多标志以及如何判断的。
+
+## 协议
+
+[MIT](./LICENSE)

package/dist/index.cjs

@@ -0,0 +1,79 @@
+'use strict';
+
+const processShim = typeof process !== "undefined" ? process : {};
+const envShim = processShim.env || {};
+const platform = envShim.UNI_PLATFORM;
+const utsPlatform = envShim.UNI_UTS_PLATFORM;
+const appPlatform = envShim.UNI_APP_PLATFORM;
+const subPlatform = envShim.UNI_SUB_PLATFORM;
+const cliContext = envShim.UNI_CLI_CONTEXT;
+const inputDir = envShim.UNI_INPUT_DIR;
+const outputDir = envShim.UNI_OUTPUT_DIR;
+const hasDarkMode = toBoolean(envShim.VUE_APP_DARK_MODE);
+const hasSourcemap = toBoolean(envShim.SOURCEMAP);
+const compiler = envShim.UNI_COMPILER;
+const nvueCompiler = envShim.UNI_NVUE_COMPILER;
+const nvueStyleCompiler = envShim.UNI_NVUE_STYLE_COMPILER;
+const compilerVersion = envShim.UNI_COMPILER_VERSION;
+const compilerVersionType = envShim.UNI_COMPILER_VERSION_TYPE;
+const statTitleJson = parseJSON(
+  envShim.STAT_TITLE_JSON
+);
+const customContext = envShim.UNI_CUSTOM_CONTEXT;
+const customScript = envShim.UNI_CUSTOM_SCRIPT;
+const customDefine = envShim.UNI_CUSTOM_DEFINE;
+const subpackage = envShim.UNI_SUBPACKAGE;
+const isMpPlugin = toBoolean(envShim.UNI_MP_PLUGIN);
+const renderer = envShim.UNI_RENDERER;
+const rendererNative = envShim.UNI_RENDERER_NATIVE;
+const isMinimize = toBoolean(envShim.UNI_MINIMIZE);
+const isSSRClient = toBoolean(envShim.UNI_SSR_CLIENT);
+const isSSRServer = toBoolean(envShim.UNI_SSR_SERVER);
+const isH5 = platform === "h5";
+const isApp = platform === "app";
+const isMp = /^mp-/i.test(platform);
+const isMpWeixin = platform === "mp-weixin";
+const isMpAlipay = platform === "mp-alipay";
+function toBoolean(val) {
+  return val ? val !== "false" : false;
+}
+function parseJSON(val) {
+  let obj;
+  try {
+    obj = JSON.parse(val || "{}");
+  } catch (error) {
+    obj = {};
+  }
+  return obj;
+}
+
+exports.appPlatform = appPlatform;
+exports.cliContext = cliContext;
+exports.compiler = compiler;
+exports.compilerVersion = compilerVersion;
+exports.compilerVersionType = compilerVersionType;
+exports.customContext = customContext;
+exports.customDefine = customDefine;
+exports.customScript = customScript;
+exports.hasDarkMode = hasDarkMode;
+exports.hasSourcemap = hasSourcemap;
+exports.inputDir = inputDir;
+exports.isApp = isApp;
+exports.isH5 = isH5;
+exports.isMinimize = isMinimize;
+exports.isMp = isMp;
+exports.isMpAlipay = isMpAlipay;
+exports.isMpPlugin = isMpPlugin;
+exports.isMpWeixin = isMpWeixin;
+exports.isSSRClient = isSSRClient;
+exports.isSSRServer = isSSRServer;
+exports.nvueCompiler = nvueCompiler;
+exports.nvueStyleCompiler = nvueStyleCompiler;
+exports.outputDir = outputDir;
+exports.platform = platform;
+exports.renderer = renderer;
+exports.rendererNative = rendererNative;
+exports.statTitleJson = statTitleJson;
+exports.subPlatform = subPlatform;
+exports.subpackage = subpackage;
+exports.utsPlatform = utsPlatform;

package/dist/index.d.ts

@@ -0,0 +1,63 @@
+type PLATFORM = "h5" | "app" | "mp-alipay" | "mp-baidu" | "mp-kuaishou" | "mp-lark" | "mp-qq" | "mp-toutiao" | "mp-weixin" | "quickapp-webview" | "quickapp-webview-huawei" | "quickapp-webview-union";
+/** Value of `process.env.UNI_PLATFORM` */
+declare const platform: PLATFORM;
+/** Value of `process.env.UNI_UTS_PLATFORM` */
+declare const utsPlatform: PLATFORM | "app-android" | "app-ios" | "web";
+/** Value of `process.env.UNI_APP_PLATFORM` */
+declare const appPlatform: "android" | "ios" | undefined;
+/** Value of `process.env.UNI_SUB_PLATFORM` */
+declare const subPlatform: "quickapp-webview-huawei" | "quickapp-webview-union" | undefined;
+/** Value of `process.env.UNI_CLI_CONTEXT` */
+declare const cliContext: string;
+/** Value of `process.env.UNI_INPUT_DIR` */
+declare const inputDir: string;
+/** Value of `process.env.UNI_OUTPUT_DIR` */
+declare const outputDir: string;
+/** Detect if `VUE_APP_DARK_MODE` environment variable is set */
+declare const hasDarkMode: boolean;
+/** Detect if `SOURCEMAP` environment variable is set */
+declare const hasSourcemap: boolean;
+/** Value of `process.env.UNI_COMPILER` */
+declare const compiler: "vue" | "nvue";
+/** Value of `process.env.UNI_NVUE_COMPILER` */
+declare const nvueCompiler: "vue" | "uni-app" | undefined;
+/** Value of `process.env.UNI_NVUE_STYLE_COMPILER` */
+declare const nvueStyleCompiler: "uni-app" | undefined;
+/** Value of `process.env.UNI_COMPILER_VERSION` */
+declare const compilerVersion: string;
+/** Value of `process.env.UNI_COMPILER_VERSION_TYPE` */
+declare const compilerVersionType: "a" | "r";
+/** Value of `process.env.STAT_TITLE_JSON` */
+declare const statTitleJson: Record<string, string>;
+/** Value of `process.env.UNI_CUSTOM_CONTEXT` */
+declare const customContext: string | undefined;
+/** Value of `process.env.UNI_CUSTOM_SCRIPT` */
+declare const customScript: string | undefined;
+/** Value of `process.env.UNI_CUSTOM_DEFINE` */
+declare const customDefine: string | undefined;
+/** Value of `process.env.UNI_SUBPACKAGE` */
+declare const subpackage: string | undefined;
+/** Detect if `UNI_MP_PLUGIN` environment variable is set */
+declare const isMpPlugin: boolean;
+/** Value of `process.env.UNI_RENDERER` */
+declare const renderer: "native" | undefined;
+/** Value of `process.env.UNI_RENDERER_NATIVE` */
+declare const rendererNative: "appService" | "pages" | undefined;
+/** Detect if `UNI_MINIMIZE` environment variable is set */
+declare const isMinimize: boolean;
+/** Detect if `UNI_SSR_CLIENT` environment variable is set  */
+declare const isSSRClient: boolean;
+/** Detect if `UNI_SSR_SERVER` environment variable is set  */
+declare const isSSRServer: boolean;
+/** Detect if `process.env.UNI_PLATFORM` is H5 */
+declare const isH5: boolean;
+/** Detect if `process.env.UNI_PLATFORM` is H5 */
+declare const isApp: boolean;
+/** Detect if `process.env.UNI_PLATFORM` is 小程序 */
+declare const isMp: boolean;
+/** Detect if `process.env.UNI_PLATFORM` is 微信小程序 */
+declare const isMpWeixin: boolean;
+/** Detect if `process.env.UNI_PLATFORM` is 支付宝小程序 */
+declare const isMpAlipay: boolean;
+
+export { appPlatform, cliContext, compiler, compilerVersion, compilerVersionType, customContext, customDefine, customScript, hasDarkMode, hasSourcemap, inputDir, isApp, isH5, isMinimize, isMp, isMpAlipay, isMpPlugin, isMpWeixin, isSSRClient, isSSRServer, nvueCompiler, nvueStyleCompiler, outputDir, platform, renderer, rendererNative, statTitleJson, subPlatform, subpackage, utsPlatform };

package/dist/index.mjs

@@ -0,0 +1,48 @@
+const processShim = typeof process !== "undefined" ? process : {};
+const envShim = processShim.env || {};
+const platform = envShim.UNI_PLATFORM;
+const utsPlatform = envShim.UNI_UTS_PLATFORM;
+const appPlatform = envShim.UNI_APP_PLATFORM;
+const subPlatform = envShim.UNI_SUB_PLATFORM;
+const cliContext = envShim.UNI_CLI_CONTEXT;
+const inputDir = envShim.UNI_INPUT_DIR;
+const outputDir = envShim.UNI_OUTPUT_DIR;
+const hasDarkMode = toBoolean(envShim.VUE_APP_DARK_MODE);
+const hasSourcemap = toBoolean(envShim.SOURCEMAP);
+const compiler = envShim.UNI_COMPILER;
+const nvueCompiler = envShim.UNI_NVUE_COMPILER;
+const nvueStyleCompiler = envShim.UNI_NVUE_STYLE_COMPILER;
+const compilerVersion = envShim.UNI_COMPILER_VERSION;
+const compilerVersionType = envShim.UNI_COMPILER_VERSION_TYPE;
+const statTitleJson = parseJSON(
+  envShim.STAT_TITLE_JSON
+);
+const customContext = envShim.UNI_CUSTOM_CONTEXT;
+const customScript = envShim.UNI_CUSTOM_SCRIPT;
+const customDefine = envShim.UNI_CUSTOM_DEFINE;
+const subpackage = envShim.UNI_SUBPACKAGE;
+const isMpPlugin = toBoolean(envShim.UNI_MP_PLUGIN);
+const renderer = envShim.UNI_RENDERER;
+const rendererNative = envShim.UNI_RENDERER_NATIVE;
+const isMinimize = toBoolean(envShim.UNI_MINIMIZE);
+const isSSRClient = toBoolean(envShim.UNI_SSR_CLIENT);
+const isSSRServer = toBoolean(envShim.UNI_SSR_SERVER);
+const isH5 = platform === "h5";
+const isApp = platform === "app";
+const isMp = /^mp-/i.test(platform);
+const isMpWeixin = platform === "mp-weixin";
+const isMpAlipay = platform === "mp-alipay";
+function toBoolean(val) {
+  return val ? val !== "false" : false;
+}
+function parseJSON(val) {
+  let obj;
+  try {
+    obj = JSON.parse(val || "{}");
+  } catch (error) {
+    obj = {};
+  }
+  return obj;
+}
+
+export { appPlatform, cliContext, compiler, compilerVersion, compilerVersionType, customContext, customDefine, customScript, hasDarkMode, hasSourcemap, inputDir, isApp, isH5, isMinimize, isMp, isMpAlipay, isMpPlugin, isMpWeixin, isSSRClient, isSSRServer, nvueCompiler, nvueStyleCompiler, outputDir, platform, renderer, rendererNative, statTitleJson, subPlatform, subpackage, utsPlatform };

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@uni-helper/uni-env",
+  "type": "module",
+  "version": "0.0.1",
+  "packageManager": "pnpm@8.1.1",
+  "description": "",
+  "author": "KeJun",
+  "license": "MIT",
+  "homepage": "https://github.com/kejunmao/@uni-helper/uni-env#readme",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/kejunmao/@uni-helper/uni-env.git"
+  },
+  "bugs": "https://github.com/kejunmao/@uni-helper/uni-env/issues",
+  "keywords": [],
+  "sideEffects": false,
+  "exports": {
+    ".": {
+      "types": "./dist/index.d.ts",
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.mjs"
+    }
+  },
+  "main": "./dist/index.mjs",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
+  "typesVersions": {
+    "*": {
+      "*": [
+        "./dist/*",
+        "./dist/index.d.ts"
+      ]
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "devDependencies": {
+    "@types/node": "^18.15.11",
+    "bumpp": "^9.1.0",
+    "esno": "^0.16.3",
+    "typescript": "^5.0.4",
+    "unbuild": "^1.2.1",
+    "vitest": "^0.30.1"
+  },
+  "scripts": {
+    "build": "unbuild",
+    "dev": "unbuild --stub",
+    "release": "bumpp",
+    "start": "esno src/index.ts"
+  }
+}