rock 0.4.0 → 0.9.0

package/README.md

@@ -1,215 +1,84 @@
-Node.js - rock
-=================
+<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>
 
-Rock generates file structures or project skeletons based off of predefined templates.
+---
 
+## React Native at scale is challenging
 
-Why?
-----
+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.
 
-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. I was getting annoyed of having to create the same file structure over and over again.
+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.
 
-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.
+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.
 
-As it stands now, `rock` is written in Node.js. But the actual templates themselves could be for any language.
+## Features
 
+**🖥️ Brand New CLI**  
+A familiar CLI experience with end-to-end development and build workflows. Migrate in just 10 minutes.
 
-Installation
-------------
+**☁️ 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.
 
-You will need Node.js and `npm` (Node.js Package Manager). This is bundled with Node.js. If you don't have `npm`, mozy on over to the [Node.js download page](https://nodejs.org/en/download/). There are prebuilt binaries and installers for most platforms including Mac OS X, Windows, and Linux.
+**🔧 GitHub Actions**  
+Complete logic for downloading, uploading, and building native artifacts for iOS (APP, IPA) and Android (APK, AAB).
 
-After you have installed Node.js and npm, you can install rock by running the following command:
+**🔗 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.
 
-    npm install -g rock
+**📦 Bundler Flexibility**  
+Rock supports both Metro and Re.Pack for JavaScript bundling. With Re.Pack, you can build Super Apps and Mobile Microfrontends.
 
-Don't forget the **-g** flag. This will ensure that the `rock` command is available system wide.
+**🔌 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.
 
+## Installation
 
-Usage
------
+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.
 
-    rock [path] -r [rock]
+### Migrating an existing Community CLI project
 
-example:
+To migrate an existing project, open a terminal in your project root and run:
 
-    rock mylib -r node-lib
-
-or
-
-    rock /tmp/mylib -r node-lib
-
-
-### 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
-   -f, --file             If the rock is a single file. Supports http as well.  [false]
-   --topen                Opening template value. Defaults to {{  [{{]
-   --tclose               Closing template value. Defaults to }}  [}}]
-```
-
-
-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:
-
-    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() {
-
-}
-```
-
-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 a few others.
-
-### Ignore Directories
-
-In your rock repo, add a file `.rock/rock.json`. Add the following:
-
-```json
-{
-    "ignoreDirs": ["./dirToIgnore"]
-}
-```
-
-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
-
-If you don't want to use the default `{{` and `}}` and want to use something else, you can configure this behavior for your Rock in `.rock/rock.json`:
-
-```json
-{
-  "tokens": {
-    "open": "#{",
-    "close": "}"
-  }
-}
-```
-
-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**:
+```shell
+npm create rock-app
 ```
-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
-```
+### Creating a new project
 
-output:
+To create a fresh React Native app with Rock, open a terminal and run:
 
-**/tmp/outputfile.txt**:
-```
-Hi, JP is going to build:
-Rock
+```shell
+npm create rock-app
 ```
 
+### Adding to an existing native project
 
+To add React Native to an existing iOS or Android app with Rock, use our Brownfield plugins:
 
-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"
-  }
-}
+```shell
+npm create rock-app
+# ...
+◆  What plugins do you want to start with?
+│  ◼ brownfield-ios
+│  ◼ brownfield-android
 ```
 
-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
-
-
-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.
 
+## Documentation
 
-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.
 
-(The MIT License)
+## Contributing
 
-Copyright (c) 2012-2013, JP Richardson
+Read our [contributing guidelines](CONTRIBUTING.md) to learn how you can contribute with bug reports, documentation, and code.
 
+## Made with ❤️ at Callstack
 
-[aboutjp]: http://about.me/jprichardson
-[twitter]: http://twitter.com/jprichardson
-[procbits]: http://procbits.com
-[gitpilot]: http://gitpilot.com
+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;

package/dist/src/lib/adHocTemplates.js

@@ -0,0 +1,366 @@
+// Template functions for ad-hoc iOS distribution
+export function templateIndexHtml({ appName, version, bundleIdentifier, }) {
+    return `<!DOCTYPE html>
+  <html lang="en">
+    <head>
+      <meta charset="UTF-8" />
+      <meta name="viewport" content="width=device-width, initial-scale=1.0" />
+      <title>Download ${appName} for iOS</title>
+      <style>
+        :root {
+          /* Light mode variables */
+          --bg-primary: #ffffff;
+          --bg-secondary: #f5f5f7;
+          --text-primary: #1d1d1f;
+          --text-secondary: #86868b;
+          --accent-primary: #8232ff;
+          --accent-hover: rgba(130, 50, 255, 0.3);
+          --border-color: #e5e5e7;
+          --shadow-color: rgba(0, 0, 0, 0.1);
+        }
+
+        @media (prefers-color-scheme: dark) {
+          :root {
+            /* Dark mode variables */
+            --bg-primary: #1c1c1e;
+            --bg-secondary: #2c2c2e;
+            --text-primary: #ffffff;
+            --text-secondary: #8e8e93;
+            --accent-primary: #8232ff;
+            --accent-hover: rgba(130, 50, 255, 0.4);
+            --border-color: #38383a;
+            --shadow-color: rgba(0, 0, 0, 0.3);
+          }
+        }
+
+        * {
+          margin: 0;
+          padding: 0;
+          box-sizing: border-box;
+        }
+
+        body {
+          font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto,
+            Oxygen, Ubuntu, Cantarell, sans-serif;
+          min-height: 100vh;
+          display: flex;
+          align-items: center;
+          justify-content: center;
+          padding: 20px;
+          font-size: 16px;
+          background-color: var(--bg-primary);
+          color: var(--text-primary);
+          transition: background-color 0.3s ease, color 0.3s ease;
+        }
+
+        .container {
+          text-align: center;
+          max-width: 500px;
+          width: 100%;
+        }
+
+        .app-icon {
+          width: 100px;
+          height: 100px;
+          margin: 0 auto 15px;
+          display: flex;
+          align-items: center;
+          justify-content: center;
+          font-size: 48px;
+          color: var(--text-primary);
+          background: var(--bg-secondary);
+          border-radius: 25px;
+          transition: background-color 0.3s ease;
+        }
+
+        h1 {
+          color: var(--text-primary);
+          font-size: 28px;
+          font-weight: 600;
+          margin-bottom: 15px;
+          overflow-wrap: break-word;
+          transition: color 0.3s ease;
+        }
+
+        .subtitle {
+          color: var(--text-secondary);
+          font-size: 16px;
+          line-height: 1.5;
+          margin-bottom: 30px;
+          transition: color 0.3s ease;
+        }
+
+        .version {
+          color: var(--text-primary);
+          font-size: 16px;
+          line-height: 1.5;
+          margin-bottom: 10px;
+          transition: color 0.3s ease;
+        }
+
+        .download-button {
+          background: var(--accent-primary);
+          color: white;
+          border: none;
+          padding: 16px 32px;
+          border-radius: 4px;
+          font-size: 14px;
+          font-weight: 600;
+          cursor: pointer;
+          transition: all 0.3s ease;
+          text-decoration: none;
+          display: inline-block;
+          margin-bottom: 20px;
+          box-shadow: 0 4px 12px var(--shadow-color);
+        }
+
+        .download-button:hover {
+          transform: translateY(-2px);
+          box-shadow: 0 8px 24px var(--accent-hover);
+        }
+
+        .download-button:active {
+          transform: translateY(0);
+        }
+
+        .instructions {
+          background: var(--bg-secondary);
+          border-radius: 4px;
+          padding: 20px;
+          margin-top: 20px;
+          text-align: left;
+          border: 1px solid var(--border-color);
+          transition: background-color 0.3s ease, border-color 0.3s ease;
+        }
+
+        .instructions h3 {
+          color: var(--text-primary);
+          font-size: 16px;
+          margin-bottom: 10px;
+          transition: color 0.3s ease;
+        }
+
+        .instructions ol {
+          color: var(--text-secondary);
+          font-size: 14px;
+          line-height: 1.6;
+          padding-left: 20px;
+          transition: color 0.3s ease;
+        }
+
+        .instructions li {
+          margin-bottom: 8px;
+        }
+
+        .adhoc-info {
+          text-align: left;
+          margin-top: 20px;
+          padding: 1em 2em;
+          border-left: 3px solid var(--accent-primary);
+          background: var(--bg-primary);
+          border-radius: 4px;
+          transition: background-color 0.3s ease;
+        }
+
+        .adhoc-info-title {
+          font-weight: 600;
+          margin-bottom: 10px;
+          color: var(--text-primary);
+          transition: color 0.3s ease;
+        }
+
+        .adhoc-info-text {
+          color: var(--text-primary);
+          margin: 0;
+          transition: color 0.3s ease;
+        }
+
+        .footer {
+          text-align: center;
+          margin-top: 40px;
+          font-size: 12px;
+          color: var(--text-secondary);
+          transition: color 0.3s ease;
+        }
+
+        .link {
+          color: var(--accent-primary);
+          text-decoration: none;
+          transition: color 0.3s ease;
+        }
+
+        .link:hover {
+          text-decoration: underline;
+        }
+
+        .toast {
+          padding: 1em 3em;
+          font-size: 14px;
+          border: 1px solid var(--accent-primary);
+          color: var(--text-primary);
+          position: fixed;
+          bottom: 1em;
+          left: 50%;
+          transform: translateX(-50%);
+          max-width: 500px;
+          width: calc(100% - 2em);
+          text-align: left;
+          border-radius: 4px;
+          background-color: var(--bg-primary);
+          display: none;
+          box-shadow: 0 8px 24px var(--shadow-color);
+          transition: background-color 0.3s ease, border-color 0.3s ease, color 0.3s ease;
+        }
+
+        .toast-visible {
+          display: block;
+          animation: slideUp 0.3s ease;
+        }
+
+        @keyframes slideUp {
+          from {
+            opacity: 0;
+            transform: translateX(-50%) translateY(20px);
+          }
+          to {
+            opacity: 1;
+            transform: translateX(-50%) translateY(0);
+          }
+        }
+
+        .toast-icon {
+          font-size: 1em;
+          position: absolute;
+          left: 1em;
+          top: 50%;
+          transform: translateY(-50%);
+        }
+
+        .toast-close {
+          font-size: 1em;
+          padding: 0.5em;
+          cursor: pointer;
+          position: absolute;
+          right: 1em;
+          top: 50%;
+          transform: translateY(-50%);
+          color: var(--text-secondary);
+          transition: color 0.3s ease;
+        }
+
+        .toast-close:hover {
+          color: var(--text-primary);
+        }
+
+        /* Smooth transitions for all elements */
+        * {
+          transition: background-color 0.3s ease, color 0.3s ease, border-color 0.3s ease;
+        }
+      </style>
+    </head>
+    <body>
+      <div class="container">
+        <div class="app-icon">📱</div>
+
+        <div id="home-screen-toast" class="toast">
+          <span class="toast-icon">💡</span>
+          <p>Check Home Screen to see installation progress</p>
+          <span class="toast-close" onclick="hideToast()">✕</span>
+        </div>
+  
+        <h1>${appName}</h1>
+        <p class="version">${bundleIdentifier} (${version})</p>
+        <p class="subtitle">
+          Download and install the latest version of our iOS app directly to your
+          device.
+        </p>
+  
+        <a href="#" id="install-link" class="download-button" onclick="showToast()">
+          Install App
+        </a>
+  
+        <script>
+          // Update the link dynamically to point to the manifest.plist
+          const link = document.getElementById('install-link');
+          const currentUrl = window.location.href;
+          const manifestUrl = currentUrl.replace('index.html', 'manifest.plist');
+          link.href = \`itms-services://?action=download-manifest&url=\${encodeURIComponent(manifestUrl)}\`;
+
+          function showToast() {
+            setTimeout(() => {
+              const toast = document.getElementById('home-screen-toast');
+              toast.classList.add('toast-visible');
+            }, 2000);
+          }
+
+          function hideToast() {
+            const toast = document.getElementById('home-screen-toast');
+            toast.classList.remove('toast-visible');
+          }
+        </script>
+  
+        <div class="instructions">
+          <h3>Installation Instructions:</h3>
+          <ol>
+            <li>Tap the "Install App" button above</li>
+            <li>When prompted, tap "Install" in the popup dialog</li>
+            <li>The app will now start installing and will be available on your home screen</li>
+          </ol>
+        </div>
+  
+        <div class="adhoc-info">
+          <p class="adhoc-info-title">Ad-hoc Distribution</p>
+          <p class="adhoc-info-text">
+            This app is distributed via ad-hoc distribution for testing purposes. 
+            Your device must either be enrolled in enterprise distribution or have its UDID added to the app's provisioning profile.
+            <br><br>
+            Learn more at <a class="link" href="https://rockjs.dev/docs/cli#ad-hoc-distribution">Rock Ad-hoc documentation</a>.
+          </p>
+        </div>
+        <div class="footer">
+          <p>
+            Generated with <a class="link" href="https://rockjs.dev">Rock</a> by
+            <a class="link" href="https://callstack.com">Callstack</a>
+          </p>
+        </div>
+      </div>
+    </body>
+  </html>
+  `;
+}
+export function templateManifestPlist({ baseUrl, ipaName, bundleIdentifier, version, appName, platformIdentifier, }) {
+    return `<?xml version="1.0" encoding="UTF-8"?>
+  <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
+  <plist version="1.0">
+  <dict>
+      <key>items</key>
+      <array>
+          <dict>
+              <key>assets</key>
+              <array>
+                  <dict>
+                      <key>kind</key>
+                      <string>software-package</string>
+                      <key>url</key>
+                      <string>${baseUrl}/${ipaName}</string>
+                  </dict>
+              </array>
+              <key>metadata</key>
+              <dict>
+                  <key>bundle-identifier</key>
+                  <string>${bundleIdentifier}</string>
+                  <key>bundle-version</key>
+                  <string>${version}</string>
+                  <key>kind</key>
+                  <string>software</string>
+                  <key>platform-identifier</key>
+                  <string>${platformIdentifier ?? 'com.apple.platform.iphoneos'}</string>
+                  <key>title</key>
+                  <string>${appName}</string>
+              </dict>
+          </dict>
+        </array>
+      </dict>
+    </plist>`;
+}
+//# sourceMappingURL=adHocTemplates.js.map

package/dist/src/lib/adHocTemplates.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adHocTemplates.js","sourceRoot":"","sources":["../../../src/lib/adHocTemplates.ts"],"names":[],"mappings":"AAAA,iDAAiD;AACjD,MAAM,UAAU,iBAAiB,CAAC,EAChC,OAAO,EACP,OAAO,EACP,gBAAgB,GAKjB;IACC,OAAO;;;;;wBAKe,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;cAuQjB,OAAO;6BACQ,gBAAgB,KAAK,OAAO;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;GAyDtD,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,qBAAqB,CAAC,EACpC,OAAO,EACP,OAAO,EACP,gBAAgB,EAChB,OAAO,EACP,OAAO,EACP,kBAAkB,GAQnB;IACC,OAAO;;;;;;;;;;;;;gCAauB,OAAO,IAAI,OAAO;;;;;;4BAMtB,gBAAgB;;4BAEhB,OAAO;;;;4BAKf,kBAAkB,IAAI,6BACxB;;4BAEU,OAAO;;;;;aAKtB,CAAC;AACd,CAAC"}