chore(release): 1.0.0

.eslintrc.json

@@ -2,7 +2,8 @@
   "parser": "@typescript-eslint/parser",
   "parserOptions": {
     "project": [
-      "./tsconfig.json"
+      "./tsconfig.json",
+      "./packages/*/tsconfig.json"
     ],
     "tsconfigRootDir": ".",
     "sourceType": "module"
@@ -16,7 +17,8 @@
   },
   "ignorePatterns": [
     "node_modules/",
-    "dist/"
+    "dist/",
+    "**/example/**"
   ],
   "rules": {
     "@typescript-eslint/interface-name-prefix": "off",

.github/workflows/release-create-auco.yaml

@@ -0,0 +1,112 @@
+name: Version Bump and Publish Create Auco
+
+on:
+  pull_request:
+    types: [closed]
+    branches: [main]
+
+jobs:
+  check_commit:
+    if: github.event.pull_request.merged == true
+    runs-on: ubuntu-latest
+    outputs:
+      SHOULD_RUN: ${{ steps.check_commit.outputs.SHOULD_RUN }}
+    steps:
+      - name: Checkout Files
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.ORG_GITHUB_TOKEN }}
+          fetch-depth: 0 # Need full git history for logs
+
+      - name: check if skip ci
+        id: check_commit
+        run: |
+          COMMIT_MESSAGE=$(git log -1 --pretty=%B)
+          if [[ "$COMMIT_MESSAGE" == *"[skip ci]"* ]]; then
+            echo "SHOULD_RUN=false" >> "$GITHUB_OUTPUT"
+          else
+            echo "SHOULD_RUN=true" >> "$GITHUB_OUTPUT"
+          fi
+
+  version-bump-create-auco:
+    needs: check_commit
+    if: ${{ needs.check_commit.outputs.SHOULD_RUN != 'false' }}
+    runs-on: ubuntu-22.04
+    defaults:
+      run:
+        working-directory: packages/create-auco
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          token: ${{ secrets.ORG_GITHUB_TOKEN }}
+          fetch-depth: 0 # Need full git history for version bumping
+
+      - name: Determine version bump type
+        id: version
+        run: |
+          commit_message=$(git log -1 --pretty=%B)
+          if [[ "$commit_message" == *"[major]"* ]]; then
+            echo "type=major" >> "$GITHUB_ENV"
+          elif [[ "$commit_message" == *"[minor]"* ]]; then
+            echo "type=minor" >> "$GITHUB_ENV"
+          elif [[ "$commit_message" == *"[prerelease]"* ]]; then
+            echo "type=prerelease --preid=rc" >> "$GITHUB_ENV"
+          else
+            echo "type=patch" >> "$GITHUB_ENV"
+          fi
+
+      - name: Set up Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '20'
+          registry-url: 'https://registry.npmjs.org/'
+
+      - name: Install dependencies
+        working-directory: .
+        run: npm install
+
+      - name: Bump version and commit (create-auco)
+        run: |
+          # Ensure we are on main and up to date
+          git reset --hard HEAD
+          git pull origin main --no-rebase --strategy=ort --no-edit
+
+          # Configure git user
+          git config --global user.name 'github-actions[bot]'
+          git config --global user.email 'github-actions[bot]@users.noreply.github.com'
+
+          # Bump version for create-auco package
+          new_version=$(npm version ${{ env.type }} -m "chore(release:create-auco): %s [skip ci]")
+          echo "NEW_VERSION=${new_version}" >> "$GITHUB_ENV"
+
+          # Push the version bump commit and tag
+          git push origin main --follow-tags
+
+      - name: Build create-auco
+        run: npm run build
+
+      - name: Publish create-auco to NPM
+        run: npm publish
+        env:
+          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Notify Slack on Success
+        if: success()
+        uses: slackapi/slack-github-action@v1.26.0
+        with:
+          channel-id: ${{ secrets.SLACK_CHANNEL_ID }}
+          slack-message: '✅ Version bump & publish successful for create-auco: ${{ env.NEW_VERSION }}'
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+
+      - name: Notify Slack on Failure
+        if: failure()
+        uses: slackapi/slack-github-action@v1.26.0
+        with:
+          channel-id: ${{ secrets.SLACK_CHANNEL_ID }}
+          slack-message: '❌ Version bump or publish failed for create-auco on main: ${{ github.ref_name }}'
+        env:
+          SLACK_BOT_TOKEN: ${{ secrets.SLACK_BOT_TOKEN }}
+
+

.gitignore

@@ -1,5 +1,8 @@
 node_modules/
-dist
+dist/
+**/dist/
 .env
 *.log
-*.db
+*.db
+*.tsbuildinfo
+**/*.tsbuildinfo

README.md

@@ -23,7 +23,61 @@ Read [our documentation](https://scaffoldstark.com/auco)
 
 ## Installation
 
-### From npm (Recommended)
+### Create a New Project
+
+The quickest way to create a new Auco project is using the create command:
+
+```bash
+# Using npm (recommended - works once published)
+npm create auco
+
+# Using yarn
+yarn create auco
+
+# Using pnpm
+pnpm create auco
+
+# Using bun
+bun create auco
+
+# Using npx (also works once published)
+npx create-auco
+```
+
+On installation, you'll see a few prompts:
+- ✓ What's the name of your project? › my-starknet-indexer
+- ✓ Which template would you like to use? › Default
+- ✓ Installed packages
+- ✓ Initialized git repository
+
+You can skip prompts by using the `--yes` flag:
+```bash
+npm create auco my-project --yes
+# or
+npx create-auco my-project --yes
+```
+
+**For Local Development/Testing:**
+
+If you're developing the `create-auco` script locally, you can test it using:
+
+```bash
+# Option 1: Run directly from the built file
+node dist/scripts/create-auco.js my-project
+
+# Option 2: Link the package globally first, then use npx
+npm link
+npx create-auco my-project
+
+# Option 3: Use npm create with the local package
+npm create auco@file:.
+```
+
+**Note:** For `npm create auco` / `yarn create auco` to work for end users, the package needs to be published as `create-auco` on npm (in addition to the main `auco` package).
+
+### Install as a Library
+
+If you want to use Auco as a library in an existing project:
 
 ```bash
 npm install auco