argent 0.1.0 → 0.26.0

package/README.md

@@ -1,18 +1,46 @@
-argent
-======
+> **Note:** `argent` is an alias for [`@swmansion/argent`](https://www.npmjs.com/package/@swmansion/argent), for use with `npx`: `npx argent@latest init` runs `@swmansion/argent` of the same version.
+> To install argent globally, run `npm install -g @swmansion/argent`. The alias refuses global installs.
 
-Declarative handling of optional parameters
+<br/>
+<p align="center"><a href="https://argent.swmansion.com"><img width="1100" height="382" alt="argent-header" src="https://github.com/user-attachments/assets/6cec01d5-da3c-4b6c-97c3-0374a63c213c" /></a></p>
 
-## Usage ##
+[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-1?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-1&n=1)
+[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-2?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-2&n=1)
+[![Ad](https://swm-delivery.com/www/images/zone-gh-argent-3?n=1)](https://swm-delivery.com/www/delivery/ck-slug.php?zoneid=zone-gh-argent-3&n=1)
 
-```javascript
-var argent = require('argent');
+**[Argent](https://argent.swmansion.com)** gives your AI assistant direct control of iOS simulators, Android emulators and devices, TVs (Apple TV, Android TV, Fire TV) and Electron/Chromium apps. Tap a button, profile a screen, reproduce a bug - without leaving the CLI.
 
-var myWrappedFunction = argent(function(arg1, arg2, arg3) {
-	// function body goes here.
-}, [
-	argent.string.regex(/[\d-]*/).def('default value'),
-	argent.and(argent.object, argent.all(['prop1', 'prop2']), argent.one(['prop3, prop4])),
-	argent.function
-]);
-```
+```bash
+npx @swmansion/argent@latest init  # pnpm: pnpm dlx @swmansion/argent@latest init
+```
+
+<p align="center"><img src="https://github.com/software-mansion/argent/blob/main/assets/showcase.gif" alt="argent showcase video gif" width="100%" /></p>
+
+## What it does
+
+- **Interact** - tap, swipe, gesture, type, hardware buttons; D-pad on TV; mouse and keyboard on desktop.
+- **Flows** - record a path once, replay it deterministically as a repro or smoke test.
+- **Visual regression** - diff a baseline against a live capture, OCR- and font-aware.
+- **Profiling** - Hermes, React DevTools, Xcode Instruments, Perfetto: renders, CPU hotspots, hangs.
+- **Debugging** - logs, network (`fetch` and native), JS evaluation, native and React trees.
+- **React Native** - build, launch and iterate, no extra setup.
+
+Ask your assistant _"What can Argent do?"_ to list every tool.
+
+## Documentation
+
+[Installation](https://docs.swmansion.com/argent/docs/fundamentals/installation) · [Platforms](https://docs.swmansion.com/argent/docs/fundamentals/supported-platforms) · [CLI](https://docs.swmansion.com/argent/docs/reference/cli) · [Editors](https://docs.swmansion.com/argent/docs/reference/editors)
+
+## Privacy
+
+Telemetry is opt-out: `argent telemetry disable`. See the [Privacy Notice](https://github.com/software-mansion/argent/blob/main/Telemetry.md).
+
+## License
+
+Argent uses a mixed licensing model. **Source code** is released under the [Apache License 2.0](LICENSE.txt). **Proprietary binaries** (the per-platform `bin/<platform>/simulator-server` and `bin/darwin/ax-service` executables and the `.dylib` files in `native-devtools-ios`) are the intellectual property of Software Mansion S.A. and are licensed solely for use within this project. Decompiling, reverse-engineering, or redistributing them without explicit written permission is prohibited. By using Argent, you acknowledge and agree to this structure. See [LICENSE](https://github.com/software-mansion/argent/blob/main/LICENSE.txt) for full details.
+
+## Argent is created by Software Mansion
+
+Since 2012 [Software Mansion](https://swmansion.com) is a software agency with experience in building web and mobile apps. We are Core React Native Contributors and experts in dealing with all kinds of React Native issues. We can help you build your next dream product – [Hire us](https://swmansion.com/contact/projects?utm_source=argent&utm_medium=readme).
+
+[![swm](https://logo.swmansion.com/logo?color=white&variant=desktop&width=150&tag=argent-github "Software Mansion")](https://swmansion.com)

package/cli.cjs

@@ -0,0 +1,6 @@
+#!/usr/bin/env node
+// `argent` on npm is an alias for @swmansion/argent, so that `npx argent <command>`
+// works. It runs the CLI of the @swmansion/argent version it pins, in this process.
+const { pathToFileURL } = require("node:url");
+
+import(pathToFileURL(require.resolve("@swmansion/argent/dist/cli.js")).href);

package/package.json

@@ -1,25 +1,32 @@
 {
   "name": "argent",
-  "version": "0.1.0",
-  "description": "Declarative handling of optional parameters",
-  "main": "index.js",
-  "scripts": {
-    "test": "node test/test.js"
-  },
+  "version": "0.26.0",
+  "description": "Alias for @swmansion/argent: `npx argent <command>` runs the @swmansion/argent CLI",
+  "license": "Apache-2.0",
   "repository": {
     "type": "git",
-    "url": "git://github.com/scrollback/argent"
+    "url": "git+https://github.com/software-mansion/argent.git"
+  },
+  "homepage": "https://docs.swmansion.com/argent",
+  "bin": {
+    "argent": "cli.cjs"
+  },
+  "scripts": {
+    "prepack": "node sync-readme.cjs",
+    "preinstall": "node preinstall.cjs"
+  },
+  "engines": {
+    "node": ">=20.12.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org",
+    "access": "public"
   },
-  "keywords": [
-    "optional",
-    "parameters",
-    "function"
+  "files": [
+    "cli.cjs",
+    "preinstall.cjs"
   ],
-  "author": "scrollback",
-  "license": "MIT",
-  "readmeFilename": "README.md",
-  "gitHead": "39159030af810ddb9cbfdc18eb9e7ffa15f04231",
-  "bugs": {
-    "url": "https://github.com/scrollback/argent/issues"
+  "dependencies": {
+    "@swmansion/argent": "0.26.0"
   }
 }

package/preinstall.cjs

@@ -0,0 +1,19 @@
+// A global install of this alias would put a second `argent` binary on PATH, which
+// clashes with @swmansion/argent (the package `argent init` installs globally) and
+// hides it from `argent update`. Global installs go to @swmansion/argent instead.
+if (process.env.npm_config_global === "true") {
+  console.error(
+    [
+      "",
+      "The `argent` package is only an alias for running argent with npx:",
+      "",
+      "  npx argent init",
+      "",
+      "To install argent globally, install @swmansion/argent:",
+      "",
+      "  npm install -g @swmansion/argent",
+      "",
+    ].join("\n")
+  );
+  process.exit(1);
+}

package/.npmignore

@@ -1,15 +0,0 @@
-lib-cov
-*.seed
-*.log
-*.csv
-*.dat
-*.out
-*.pid
-*.gz
-
-pids
-logs
-results
-
-npm-debug.log
-node_modules

package/LICENSE

@@ -1,20 +0,0 @@
-The MIT License (MIT)
-
-Copyright (c) 2013 scrollback
-
-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/index.js

@@ -1,143 +0,0 @@
-var argent = function(fn, spec) {
-	return function() {
-		var i=0, j=0, args=[];
-		while(j<spec.length) {
-			if(i<arguments.length && spec[j].test(arguments[i])) { 
-				args[j] = arguments[i];
-				i++; j++;
-			} else {
-				args[j] = spec[j]._def;
-				j++;
-			}
-		}
-		return fn.apply(this, args);
-	};
-};
-
-function helper(name, fn, modfn, opt) {
-	var i;
-	opt = opt || {};
-	opt.def = opt.def || function(d) { this._def = d; };
-	
-	argent[name] = function() {
-		var mod = [].splice.call(arguments, 0),
-			constraint = Object.create(opt);
-		
-		if(!fn) fn = function() { return true; };
-		
-		constraint.test = (mod && modfn? function(v) { 
-			return fn(v) && modfn.apply(null, [v].concat(mod)); 
-		}: fn);
-		
-		return constraint;
-	}
-	for(i in opt) argent[name][i] = opt[i];
-	argent[name].test = fn;
-}
-
-/*
-	How this works
-	--------------
-	
-	helper() is called with the name and two functions. The first is
-	used when the spec uses the basic helper [argent.myHelper] while
-	both functions are used when the helper has been customized
-	[argent.myHelper(default, additionalConstraints)]
-	
-	When the helper is called as a function (customization mode),
-	the first parameter is treated as a default value (if it passes
-	the basic constraint for that helper) and all remaining params
-	are passed to the modfn.
-	
-	Example: Consider the 'string' constraint:
-	
-	In the basic mode [argent.string], it just verifies that typeof
-	argument is string. This helper can be further customized by 
-	requiring that arguments must also match a supplied regex
-	[argent.string(myRegex)], providing a default value 
-	[argent.string(def)], or both [argent.string(def, myRegex)].
-	
-	When argent.string sees only one parameter, we check if that
-	parameter satisfies the basic constraint typeof == string to
-	decide between treating that parameter as a regex or a default
-	value.
-
-*/
-
-helper('string', 
-	function(v) { return typeof v === 'string'; }, 
-	function(v, regex) { return regex.test? regex.test(v): true; }
-);
-
-helper('number', function(v) { return typeof v === 'number'; });
-helper('boolean', function(v) { return typeof v === 'boolean'; });
-
-/*
-	The 'function' helper can be further constrained with the number
-	of arguments in the callback function's specification
-*/
-helper('function',
-	function(v) { return typeof v === 'function'; },
-	function(v, length) { return v.length === length; }
-);
-
-helper('array',
-	function(v) { return Object.prototype.toString.call(v) === "[object Array]" }
-);
-
-
-helper('object', function(v) { return typeof v === 'object' && v !== null; });
-
-/*
-	The 'all' and 'any' helpers check property names on objects; use an
-	an 'and' helper to combine them with an 'object' helper.
-*/
-helper(
-	'all', null,
-	function(v, props) {
-		var i, l;
-		for(i=0, l=props.length; i<l; i++) {
-			if(typeof v[props[i]] === 'undefined') return false;
-		}
-		return true;
-	}
-);
-
-helper(
-	'one', null,
-	function(v, props) {
-		var i, l;
-		for(i=0, l=props.length; i<l; i++) {
-			if(typeof v[props[i]] !== 'undefined') return true;
-		}
-		return true;
-	}
-);
-
-helper('anything', null);
-helper('defined', function(v) { return typeof v !== 'undefined'; });
-helper('nonnull', function(v) { return typeof v !== 'undefined' && v !== null; });
-helper('truthy', function(v) { return !!v; });
-
-helper('or', null,
-	function(v) {
-		var i, l;
-		for(i=1, l=arguments.length; i<l; i++) {
-			if(arguments[i].test(v)) return true;
-		}
-		return false;
-	}
-);
-
-helper('and', null,
-	function(v) {
-		var i, l;
-		for(i=1, l=arguments.length; i<l; i++) {
-			if(!arguments[i].test(v)) return false;
-		}
-		return true;
-	}
-);
-
-
-module.exports = argent;

package/test/test.js

@@ -1,25 +0,0 @@
-var argent = require('../index.js'),
-	assert = require('assert');
-
-var test = argent(function(str, phone, num, user, cb) {
-	console.log(arguments);
-}, [
-	argent.string,
-	argent.string(/\d+/),
-	argent.number,
-	argent.and(argent.object, argent.all(['name', 'email'])),
-	argent.function
-]);
-
-
-console.log(1);
-test(function() {});
-
-console.log(2);
-test('asdf', 34, function() {});
-
-console.log(3);
-test('asdf', {}, function() {});
-
-console.log(4);
-test({name: 'hah', email: 'rew'});