feat: create expo-plugin-aboutlibraries

explodingcamera · explodingcamera · commit 8ac8fe4ab36c · 2023-01-30T21:08:43.000+01:00
Signed-off-by: Henry Gressmann &lt;mail@henrygressmann.de&gt;
diff --git a/.changeset/curly-ladybugs-protect.md b/.changeset/curly-ladybugs-protect.md
@@ -0,0 +1,5 @@
+---
+"expo-plugin-aboutlibraries": patch
+---
+
+initial version
diff --git a/.changeset/eighty-wasps-hug.md b/.changeset/eighty-wasps-hug.md
@@ -1,5 +1,5 @@
 ---
-"ucmd": patch
+"ucmd": minor
 ---
 
 finish parse function
diff --git a/README.md b/README.md
@@ -6,12 +6,13 @@
 
 ## Projects
 
-| Stable                                                                                                                                                                                  | &nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp; |
-| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |
-| [![](https://img.shields.io/npm/v/rollup-plugin-minify-template-literals?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/rollup-plugin-minify-template-literals) | [**`rollup-plugin-minify-template-literals`**](./packages/rollup-plugin-minify-template-literals) <br/> A rollup & vite plugin to minify html/css template literals                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                              |
-| [![](https://img.shields.io/npm/v/minify-literals?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/minify-literals)                                               | [**`minify-literals`**](./packages/minify-literals) <br/> A library to minify html/css template literals                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                         |
+| Stable                                                                                                                                                                                  |                                                                                                                                                                     |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [![](https://img.shields.io/npm/v/rollup-plugin-minify-template-literals?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/rollup-plugin-minify-template-literals) | [**`rollup-plugin-minify-template-literals`**](./packages/rollup-plugin-minify-template-literals) <br/> A rollup & vite plugin to minify html/css template literals |
+| [![](https://img.shields.io/npm/v/minify-literals?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/minify-literals)                                               | [**`minify-literals`**](./packages/minify-literals) <br/> A library to minify html/css template literals                                                            |
 
-| Unstable                                                                                                              |                                                                                                                        |
-| --------------------------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------- |
-| [![](https://img.shields.io/npm/v/ucmd?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/ucmd)   | [**`ucmd`**](./packages/ucmd) <br/> minimal and strictly typed argument parsing for node.js 19+                        |
-| [![](https://img.shields.io/npm/v/lit-q?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/lit-q) | [**`lit-q`**](./packages/lit-q) <br/> A simple async query/mutation library for Lit/LitElement inspired by react-query |
+| Unstable                                                                                                                                                        |                                                                                                                                                         |
+| --------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------- |
+| [![](https://img.shields.io/npm/v/ucmd?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/ucmd)                                             | [**`ucmd`**](./packages/ucmd) <br/> minimal and strictly typed argument parsing for node.js 19+                                                         |
+| [![](https://img.shields.io/npm/v/lit-q?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/lit-q)                                           | [**`lit-q`**](./packages/lit-q) <br/> A simple async query/mutation library for Lit/LitElement inspired by react-query                                  |
+| [![](https://img.shields.io/npm/v/expo-plugin-aboutlibraries?style=flat&colorA=000000&colorB=efefef)](https://www.npmjs.com/package/expo-plugin-aboutlibraries) | [**`expo-plugin-aboutlibraries`**](./packages/expo-plugin-aboutlibraries) <br/> A simple expo config plugin to install the AboutLibraries gradle plugin |
diff --git a/packages/expo-plugin-aboutlibraries/CHANGELOG.md b/packages/expo-plugin-aboutlibraries/CHANGELOG.md
@@ -0,0 +1,13 @@
+# template
+
+## 0.1.1
+
+### Patch Changes
+
+- [`1a2bed9`](https://github.com/explodingcamera/esm/commit/1a2bed92806690fe6bd2eba714c81d05d4d725c8) Thanks [@explodingcamera](https://github.com/explodingcamera)! - add api docs link to readme
+
+## 0.1.0
+
+### Minor Changes
+
+- [`cb24d87`](https://github.com/explodingcamera/esm/commit/cb24d87d3027b6da3477a2ab8eb7e9fe79ba5656) Thanks [@explodingcamera](https://github.com/explodingcamera)! - cleanup package.json
diff --git a/packages/expo-plugin-aboutlibraries/README.md b/packages/expo-plugin-aboutlibraries/README.md
@@ -0,0 +1,38 @@
+# `expo-plugin-aboutlibraries`
+
+A simple expo config plugin to add [AboutLibraries](https://github.com/mikepenz/AboutLibraries) as a gradle plugin to your app.
+
+## Installation
+
+```sh
+expo install expo-plugin-aboutlibraries
+```
+
+## Usage
+
+```js
+// app.config.js or app.json
+
+module.exports = {
+  plugins: [
+    [
+      "expo-plugin-aboutlibraries",
+      {
+        aboutLibrariesVersion: "10.5.2", // optional, defaults to 10.5.2
+      },
+    ],
+  ],
+};
+```
+
+Now you can use AboutLibraries to generate a list of native libraries used in your app.
+
+```sh
+# apply the new config
+$ expo prebuild
+
+$ cd android
+
+# This will generate a file called aboutLibraries.json in the assets folder
+$ ./gradlew app:exportLibraryDefinitions -PaboutLibraries.exportPath=../../assets -PaboutLibraries.exportVariant=release
+```
diff --git a/packages/expo-plugin-aboutlibraries/lib/index.test.ts b/packages/expo-plugin-aboutlibraries/lib/index.test.ts
@@ -0,0 +1,5 @@
+import { test, expect } from "vitest";
+
+test("test", async () => {
+	expect(1).toBe(1);
+});
diff --git a/packages/expo-plugin-aboutlibraries/lib/index.ts b/packages/expo-plugin-aboutlibraries/lib/index.ts
@@ -0,0 +1,63 @@
+import { ConfigPlugin, createRunOncePlugin, withAppBuildGradle, withProjectBuildGradle } from "@expo/config-plugins";
+import pkg from "../package.json";
+
+const DEFAULT_VERSION = "10.5.2";
+
+const newString = (text: string) =>
+	`// --- start of expo-plugin-aboutlibraries\n${text}\n// --- end of expo-plugin-aboutlibraries`;
+
+const withAboutLibrariesApp: ConfigPlugin = (config) => {
+	return withAppBuildGradle(config, (config) => {
+		if (config.modResults.contents.includes("// --- start of expo-plugin-aboutlibraries")) return config;
+
+		if (config.modResults.language !== "groovy")
+			throw new Error(`Cannot automatically configure project build.gradle if it's not groovy`);
+
+		config.modResults.contents = `${newString("apply plugin: 'com.mikepenz.aboutlibraries.plugin'")}\n${
+			config.modResults.contents
+		}`;
+
+		return config;
+	});
+};
+
+const withAboutLibrariesProject: ConfigPlugin<{ aboutLibrariesVersion: string }> = (
+	config,
+	{ aboutLibrariesVersion },
+) => {
+	return withProjectBuildGradle(config, (config) => {
+		if (config.modResults.contents.includes("// --- start of expo-plugin-aboutlibraries")) {
+			config.modResults.contents = config.modResults.contents.replace(
+				// replace the version number
+				/id 'com.mikepenz.aboutlibraries.plugin' version '(.*)' apply false/,
+				`id 'com.mikepenz.aboutlibraries.plugin' version '${aboutLibrariesVersion}' apply false`,
+			);
+			return config;
+		}
+
+		if (config.modResults.language !== "groovy")
+			throw new Error(`Cannot automatically configure project build.gradle if it's not groovy`);
+
+		const plugin = newString(
+			`plugins {\n  id 'com.mikepenz.aboutlibraries.plugin' version "${aboutLibrariesVersion}" apply false\n}`,
+		);
+
+		config.modResults.contents = config.modResults.contents.replace("allprojects {", `\n${plugin}\n\nallprojects {`);
+
+		return config;
+	});
+};
+
+const withAboutLibraries: ConfigPlugin<{
+	aboutLibrariesVersion?: string;
+}> = (config, value) => {
+	const ABOUT_LIBRARIES_VERSION = value?.aboutLibrariesVersion ?? DEFAULT_VERSION;
+
+	config = withAboutLibrariesApp(config);
+	config = withAboutLibrariesProject(config, { aboutLibrariesVersion: ABOUT_LIBRARIES_VERSION });
+
+	return config;
+};
+
+export const withAndroidAboutLibraries = createRunOncePlugin(withAboutLibraries, pkg.name, pkg.version);
+export default withAndroidAboutLibraries;
diff --git a/packages/expo-plugin-aboutlibraries/package.json b/packages/expo-plugin-aboutlibraries/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "expo-plugin-aboutlibraries",
+  "version": "0.1.0",
+  "private": true,
+  "description": "",
+  "keywords": [],
+  "homepage": "https://github.com/explodingcamera/esm/tree/main/packages/expo-plugin-aboutlibraries",
+  "repository": "https://github.com/explodingcamera/esm",
+  "license": "ISC",
+  "author": "Henry Gressmann <mail@henrygressmann.de> (https://henrygressmann.de)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "scripts build --name expo-plugin-aboutlibraries",
+    "test": "scripts test run"
+  },
+  "devDependencies": {
+    "scripts": "workspace:*",
+    "vitest": "^0.28.3"
+  },
+  "dependencies": {
+    "@expo/config-plugins": "^5.0.4"
+  }
+}
diff --git a/packages/expo-plugin-aboutlibraries/tsconfig.json b/packages/expo-plugin-aboutlibraries/tsconfig.json
@@ -0,0 +1,7 @@
+{
+  "compilerOptions": {
+    "resolveJsonModule": true
+  },
+  "exclude": ["dist/", "node_modules/"],
+  "extends": "../../configs/tsconfig.base.json"
+}
diff --git a/packages/legalizer/CHANGELOG.md b/packages/legalizer/CHANGELOG.md
@@ -0,0 +1,13 @@
+# template
+
+## 0.1.1
+
+### Patch Changes
+
+- [`1a2bed9`](https://github.com/explodingcamera/esm/commit/1a2bed92806690fe6bd2eba714c81d05d4d725c8) Thanks [@explodingcamera](https://github.com/explodingcamera)! - add api docs link to readme
+
+## 0.1.0
+
+### Minor Changes
+
+- [`cb24d87`](https://github.com/explodingcamera/esm/commit/cb24d87d3027b6da3477a2ab8eb7e9fe79ba5656) Thanks [@explodingcamera](https://github.com/explodingcamera)! - cleanup package.json
diff --git a/packages/legalizer/README.md b/packages/legalizer/README.md
@@ -0,0 +1 @@
+# (WIP) Generate License Information from all dependencies in a project
diff --git a/packages/legalizer/bin.mjs b/packages/legalizer/bin.mjs
@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+import "./dist/index.js";
diff --git a/packages/legalizer/lib/index.test.ts b/packages/legalizer/lib/index.test.ts
@@ -0,0 +1,6 @@
+import { test, expect } from "vitest";
+import { func } from ".";
+
+test("test", async () => {
+	expect(func()).toMatchInlineSnapshot('"Hello, World!"');
+});
diff --git a/packages/legalizer/lib/index.ts b/packages/legalizer/lib/index.ts
@@ -0,0 +1,3 @@
+export const func = () => {
+	return "Hello, World!";
+};
diff --git a/packages/legalizer/package.json b/packages/legalizer/package.json
@@ -0,0 +1,40 @@
+{
+  "name": "legalizer",
+  "version": "0.1.1",
+  "private": true,
+  "description": "",
+  "bin": {
+    "legalizer": "bin.mjs"
+  },
+  "keywords": [],
+  "homepage": "https://github.com/explodingcamera/esm/tree/main/packages/legalizer",
+  "repository": "https://github.com/explodingcamera/esm",
+  "license": "ISC",
+  "author": "Henry Gressmann <mail@henrygressmann.de> (https://henrygressmann.de)",
+  "type": "module",
+  "exports": {
+    ".": {
+      "require": "./dist/index.cjs",
+      "import": "./dist/index.js",
+      "types": "./types/index.d.ts"
+    }
+  },
+  "main": "dist/index.cjs",
+  "module": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist"
+  ],
+  "scripts": {
+    "build": "scripts build --name legalizer",
+    "test": "scripts test run"
+  },
+  "dependencies": {
+    "@pnpm/lockfile-file": "^7.0.2",
+    "ucmd": "^0.2.0"
+  },
+  "devDependencies": {
+    "scripts": "workspace:*",
+    "vitest": "^0.28.3"
+  }
+}
diff --git a/packages/legalizer/tsconfig.json b/packages/legalizer/tsconfig.json
@@ -0,0 +1,4 @@
+{
+  "exclude": ["dist/", "node_modules/"],
+  "extends": "../../configs/tsconfig.base.json"
+}
diff --git a/packages/lit-q/package.json b/packages/lit-q/package.json
@@ -39,7 +39,7 @@
     "lit": "^2.6.1",
     "scripts": "workspace:0.0.1",
     "vite": "^4.0.4",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.3"
   },
   "peerDependencies": {
     "lit": "^2.5.0"
diff --git a/packages/minify-literals/package.json b/packages/minify-literals/package.json
@@ -44,6 +44,6 @@
     "@types/sinon": "^10.0.13",
     "scripts": "workspace:*",
     "sinon": "^15.0.1",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.3"
   }
 }
diff --git a/packages/rollup-plugin-minify-template-literals/package.json b/packages/rollup-plugin-minify-template-literals/package.json
@@ -43,9 +43,9 @@
   },
   "devDependencies": {
     "@types/sinon": "^10.0.13",
-    "rollup": "^3.10.1",
+    "rollup": "^3.12.0",
     "scripts": "workspace:*",
     "sinon": "^15.0.1",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.3"
   }
 }
diff --git a/packages/template/package.json b/packages/template/package.json
@@ -28,6 +28,6 @@
   },
   "devDependencies": {
     "scripts": "workspace:*",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.3"
   }
 }
diff --git a/packages/ucmd/package.json b/packages/ucmd/package.json
@@ -27,7 +27,7 @@
   },
   "devDependencies": {
     "tsup": "^6.5.0",
-    "vitest": "^0.28.2"
+    "vitest": "^0.28.3"
   },
   "engines": {
     "node": ">=19.0.0"
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/scripts/package.json b/scripts/package.json

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"expo-plugin-aboutlibraries": patch
 +---
++
 +initial version