rock 0.3.1 → 0.8.13

package/README.md

@@ -1,229 +1,84 @@
+<a href="https://www.callstack.com/open-source?utm_campaign=generic&utm_source=github&utm_medium=referral&utm_content=rock" align="center">
+  <picture>
+    <img alt="Rock" src="https://github.com/user-attachments/assets/417baa3c-ae36-447f-baf9-1e0f423c3433">
+  </picture>
+</a>
+<p align="center">
+  🪨 Rock is a cross-platform React Native app development and build toolchain built for modularity, build reuse, and incremental adoption. It integrates seamlessly with your existing infrastructure, giving you complete control without vendor lock-in.
+</p>
 
+---
 
-Node.js - rock
-=================
+## React Native at scale is challenging
 
-Rock generates file structures or project skeletons based off of predefined templates. You can find a list of all of the templates on the [Github rocktemplates page][1].
+Enterprise apps aren't built overnight. As maintainers of the Community CLI and partners to enterprise teams, we've seen the real challenges: high build times, difficulty adopting new third-party cloud services, and high barriers to introducing React Native into existing iOS and Android apps.
 
+Rock simplifies native build setup and reuse. In most React Native codebases, only about 10% of code changes affect the native iOS/Android files. Yet most teams rebuild their native apps constantly—on every commit, PR, or merge to main—when it's completely unnecessary.
 
-Why?
-----
+Rock leverages this insight by providing intelligent caching in your cloud infrastructure, seamlessly integrated through its CLI. This allows you to skip up to 90% of unnecessary native builds.
 
-Do you constantly finding yourself writing a lot of new libraries for Node.js and having to create the `package.json`, `README`, `LICENSE`, `lib/`, `test/` files over and over again? Well, I did. Sometimes I was writing JavaScript libraries or CoffeeScript apps. But over and over I was getting annoyed of having to create the same file structure over and over again.
+## Features
 
-I stumbled upon a few solutions, but they all seem to do more than just generate a file structure from a template. That's all I wanted. Oh, and I wanted it to be programmatic too. So, if I wanted to build a blogging engine or another Rails clone in JS, I could leverage `rock` to generate the empty templates.
+**🖥️ Brand New CLI**  
+A familiar CLI experience with end-to-end development and build workflows. Migrate in just 10 minutes.
 
-As it stands now, `rock` is written in Node.js. But the actual templates themselves could be for any language.
+**☁️ Reusable Cloud Builds**  
+Reliable caching of native artifacts (APK, IPA) that you can store wherever you prefer, or use our out-of-the-box integrations with GitHub, S3, and R2.
 
+**🔧 GitHub Actions**  
+Complete logic for downloading, uploading, and building native artifacts for iOS (APP, IPA) and Android (APK, AAB).
 
+**🔗 Plug-and-Play Brownfield**  
+Package your React Native app as a framework and integrate it into your iOS and Android apps just like any other library.
 
-Installation
-------------
+**📦 Bundler Flexibility**  
+Rock supports both Metro and Re.Pack for JavaScript bundling. With Re.Pack, you can build Super Apps and Mobile Microfrontends.
 
-You will need Node.js and `npm` (Node.js Package Manager). This is included in the downloadable Node.js packages. If you don't have `npm`, mozy on over to the [latest Node.js package page][2]. There are prebuilt binaries and installers for most platforms including Mac OS X, Windows, and Linux.
+**🔌 Extensible Plugin System**  
+Built with modularity in mind, Rock allows you to extend its capabilities through plugins that integrate with both the CLI and native templates.
 
-After you have installed Node.js and npm, you can install rock by running the following command:
+## Installation
 
-    npm install -g rock
+Rock is designed for incremental adoption. Whether you're just starting with React Native in your iOS or Android app, or want to migrate from the React Native Community CLI, you can do it step-by-step without having to figure everything out at once.
 
-Don't forget the **-g** flag. This will ensure that the `rock` command is available system wide.
+### Migrating an existing Community CLI project
 
-**Note:**
-At this time, `rock` requires `git` to be installed. This is because all the templates are hosted on Github. Since Github also provides tarballs and zipballs, this requirement will change soon.
+To migrate an existing project, open a terminal in your project root and run:
 
-
-### After Install
-
-After install, `rock` will create the file `rockconf.json` in your `~/.rock/` directory. You can modify this file to include additional repositories if you like.
-
-
-
-Usage
------
-
-    rock [path] -r [rock]
-
-example:
-
-    rock mylib -r node-lib
-or
-
-    rock /tmp/mylib -r node-lib
-
-
-### Options
-
-    Options:
-      --version              Print version and exit.
-      -r ROCK, --rock ROCK   The rock path or Github repo.
-      -c, --config           The config file. Defaults to ~/.rock/rock.conf.json
-
-
-want to create a project from a rock hosted somewhere else? No problem:
-
-    rock myapp -r git@github.com:johndoe/myrepo.git
-
-or use Github shorthand a la [component](https://github.com/component/component)
-
-    rock myapp -r johndoe/myrepo
-
-
-Make Your Own Rocks
--------------------
-
-It's stupidly simple to make your own rocks. Create a Git repository on Github or an empty directory on your filesystem. Start making template files. 
-
-Example (myproject.js):
-
-```javascript
-/*
-   Author: {{author}} <{{email}}>
-   File: {{file}}
-   Created: {{date}}
-*/
-
-function main() {
-  
-}
+```shell
+npm create rock-app
 ```
 
-Now, when you run:
-
-    rock myproj -r /path/to/my/rock/repo
-
-Rock will prompt:
-
-    author: [YOU_TYPE_YOUR_NAME_HERE]
-    email: [YOU_TYPE_YOUR_EMAIL_HERE]
-
-
-Rock, then will create the file structure of your new project with the values of your template tokens replaced with what you typed. Rock already understands `file`, `date`, and few others.
+### Creating a new project
 
-### Ignore Directories
+To create a fresh React Native app with Rock, open a terminal and run:
 
-In your rock repo, add a file `.rock/rock.json`. Add the following:
-
-```json
-{
-    "ignoreDirs": ["./dirToIgnore"]
-}
+```shell
+npm create rock-app
 ```
 
-Why would you do this? Let's say that you're calling rock programmatically and you don't want rock to prompt you for any tokens because you are going to use Mustache/Hogan/Handlebars in your own code.
-
-
-### Open / Close Templates
+### Adding to an existing native project
 
-If you don't want to use the default `{{` and `}}` and want to use something else, you can configure this behavior for your Rock:
+To add React Native to an existing iOS or Android app with Rock, use our Brownfield plugins:
 
-```json
-{
-  "tokens": {
-    "open": "#{",
-    "close": "}"
-  }
-}
+```shell
+npm create rock-app
+# ...
+◆  What plugins do you want to start with?
+│  ◼ brownfield-ios
+│  ◼ brownfield-android
 ```
 
-You may want to do this if you  generate files that actually use Mustache templates.
-
-
-
-Single File Rocks
------------------
-
-Rock doesn't need to be used with just whole repos. It can be used with individual files as well.
-
-**Example:**
-
-**http://localhost/data.txt**:
-```
-Hi, @@author@@ is going to build:
-@@project-name@@.
-```
-
-command:
-
-    rock /tmp/outputfile.txt -f --topen '@@' --tclose '@@' -r http://localhost/data.txt
-
-
-prompts:
-
-```
-author: JP
-project-name: Rock
-```
-
-output:
-
-**/tmp/outputfile.txt**:
-```
-Hi, JP is going to build:
-Rock
-```
-
-
-
-rock.conf.json
---------------
-
-This file defaults to `~/.rock/rock.conf.json`. You can set default values (prompt or skip).
-
-```json
-{
-  "templateValues": {
-    "author": "JP Richardson"
-  },
-  "defaultValues": {
-    "email": "jprichardson@gmail.com"
-  }
-}
-```
-
-So, if you were to run:
-
-    rock myapp -r rocktemplates/node-bin 
-
-it would not prompt you for `author` and it would prompt you for `email` but with a default of `jprichardson@gmail.com`.
-
-
-
-Rocks
-------
-
-See more rocks at: https://github.com/rocktemplates or browse 3rd party Rocks here: https://github.com/rocktemplates/rock/wiki/rocks
-
-
-[1]: https://github.com/rocktemplates
-[2]: http://nodejs.org/dist/latest/
-
-
-
-Roadmap to v1.0.0
-------------------
-
-- Will probably change configuration from JSON to [TOML](https://github.com/mojombo/toml). TOML needs to
-achieve stability first.
-- Create/fork site similar to [component.io](http://component.io/)
-
-
-Contributors
-------------
-
-- (*) [JP Richardson](http://github.com/jprichardson)
-- (1) [Tayler Summers](https://github.com/taylers)
-
+For detailed instructions, please follow our [Integrating with Native Apps](https://rockjs.dev/docs/brownfield/intro) documentation.
 
-License
--------
+## Documentation
 
-(The MIT License)
+Visit [rockjs.dev](https://rockjs.dev) to learn more about the framework, why we created it, how it can be useful to you, and how to use it in more advanced scenarios.
 
-Copyright (c) 2012-2013, JP Richardson
+## Contributing
 
+Read our [contributing guidelines](CONTRIBUTING.md) to learn how you can contribute with bug reports, documentation, and code.
 
-[aboutjp]: http://about.me/jprichardson
-[twitter]: http://twitter.com/jprichardson
-[procbits]: http://procbits.com
-[gitpilot]: http://gitpilot.com
+## Made with ❤️ at Callstack
 
+Rock is an open source project and will always remain free to use. If you think it's cool, please star it 🌟. [Callstack](https://www.callstack.com/?utm_source=github.com&utm_medium=referral&utm_campaign=rock&utm_term=readme-with-love) is a group of React and React Native geeks. Contact us at [hello@callstack.com](mailto:hello@callstack.com) if you need any help with these technologies or just want to say hi!

package/dist/src/bin.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/src/bin.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.d.ts","sourceRoot":"","sources":["../../src/bin.ts"],"names":[],"mappings":""}

package/dist/src/bin.js

@@ -0,0 +1,7 @@
+#!/usr/bin/env node
+import { cli } from './lib/cli.js';
+cli({
+    argv: process.argv,
+    cwd: process.cwd(),
+});
+//# sourceMappingURL=bin.js.map

package/dist/src/bin.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"bin.js","sourceRoot":"","sources":["../../src/bin.ts"],"names":[],"mappings":";AAEA,OAAO,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AAEnC,GAAG,CAAC;IACF,IAAI,EAAE,OAAO,CAAC,IAAI;IAClB,GAAG,EAAE,OAAO,CAAC,GAAG,EAAE;CACnB,CAAC,CAAC"}

package/dist/src/index.d.ts

@@ -0,0 +1,2 @@
+export * from './lib/cli.js';
+export type { Config } from '@rock-js/config';

package/dist/src/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC;AAC7B,YAAY,EAAE,MAAM,EAAE,MAAM,cAAc,CAAC"}

package/dist/src/index.js

@@ -0,0 +1,2 @@
+export * from './lib/cli.js';
+//# sourceMappingURL=index.js.map

package/dist/src/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/index.ts"],"names":[],"mappings":"AAAA,cAAc,cAAc,CAAC"}

package/dist/src/lib/adHocTemplates.d.ts

@@ -0,0 +1,13 @@
+export declare function templateIndexHtml({ appName, version, bundleIdentifier, }: {
+    appName: string;
+    version: string;
+    bundleIdentifier: string;
+}): string;
+export declare function templateManifestPlist({ baseUrl, ipaName, bundleIdentifier, version, appName, platformIdentifier, }: {
+    baseUrl: string;
+    ipaName: string;
+    bundleIdentifier: string;
+    version: string;
+    appName: string;
+    platformIdentifier: string;
+}): string;