wslc-wip 0.14.1 → 0.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 103045e33c74bb6772808c9a2e3029d35c90ce190c520df0ecc6d2a803b6108b
-  data.tar.gz: c70c47ae4c0d45a3ec0f9d695e4359d1d8915e5716b546c52d53280c1e49d09a
+  metadata.gz: b8248f18abf8e946e333de3e2e9b70e72b9b0f8806a3216c97e62bfe83ad53bb
+  data.tar.gz: 19119fe6787aad4b17cc6ed9e1f1048d664cbcd119414bd4bc4b86e0c26dfb5d
 SHA512:
-  metadata.gz: b51cdbdfe08a7d51ef750a8a5190583c9f3de894bf5e419b5890a6cdbfda4c9da1a1ab6fb175b763669100564e2e1741ff4bfc1dbf2819e46358680515e5fafb
-  data.tar.gz: 91b3608c4666a2e1023b3ce9e7069fe29d3fc8ecfa03cf0641e5e6da8d487b89b4fed13b3d948040e8b65b4d5e4828ac361b1be96ce8be470dbca8be58f58e5c
+  metadata.gz: 91535a4b496bc4cc2e55cc44d7feadbf8709811df0ab660c7d7fe8e6f20feccac18a497804b13bd83a6d2775396e3061c51f64040864e3d6635eeaf22edf9b8e
+  data.tar.gz: 1151d286900c2c11812c607f123d966862ea41b1ac5ee01a74d957f0626667c616fdabf13f618fdad4a62a1b4c8a26f1c68bf837030f1e8f4508a8f2d0e733b1

data/README.md

@@ -181,6 +181,17 @@ sync:
     tag: null          # optional (default: "wip-sync-<container>:latest")
 ```
 
+`wip init --template NAME` writes `exclude`'s default list live, picked from that stack's own
+`github/gitignore` template:
+
+| `--template` | Stack | Default `exclude` |
+|---|---|---|
+| `rails` | Rails | `.git`, `log/`, `tmp/`, `storage/`, `public/assets/`, `public/packs/`, `.bundle/`, `vendor/bundle/`, `coverage/`, `node_modules/` |
+| `node` | Node.js | `.git`, `node_modules/`, `dist/`, `build/`, `.next/`, `.cache/`, `coverage/` |
+| `rust` | Rust | `.git`, `target/` |
+| `csharp` | C# | `.git`, `bin/`, `obj/`, `.vs/`, `packages/` |
+| (omitted) | — | `.git`, `tmp/`, `node_modules/` |
+
 Everything below `sync:` is optional — `sync: {}` alone already works. With it in place:
 
 - Any `volumes` entry on the primary container mounting `target` (the usual `.:/app`) is replaced
@@ -341,7 +352,7 @@ valid compose.yml over sections it doesn't need to look at:
 
 | Command | Description |
 |---|---|
-| `wip init [--force]` | Write a starter `wip.yml`: `mode: compose-native` if a `compose.yml`/`docker-compose.yml` is found next to it, `mode: container` otherwise. Refuses to overwrite an existing `wip.yml` unless `--force` |
+| `wip init [--force] [--template NAME]` | Write a starter `wip.yml`: `mode: compose-native` if a `compose.yml`/`docker-compose.yml` is found next to it, `mode: container` otherwise. `--template` picks `sync.exclude`'s default patterns for a stack (`rails`, `node`, `rust`, `csharp`); omitted, it falls back to `.git`/`tmp/`/`node_modules/`. Refuses to overwrite an existing `wip.yml` unless `--force` |
 | `wip version` | wip's version, plus WSLC's if it can be detected |
 | `wip doctor` | Diagnose WSL2, interop, WSLC, config, architecture, and Git |
 | `wip config` | Print the effective configuration (secrets masked) |

data/lib/wip/cli.rb

@@ -42,11 +42,13 @@ module Wip
 
     desc 'init', 'Create a starter wip.yml (detects an existing compose.yml/docker-compose.yml)'
     option :force, type: :boolean, default: false, desc: 'Overwrite an existing wip.yml'
+    option :template, type: :string,
+                      desc: "sync.exclude preset: #{Initializer::TEMPLATE_LABELS.keys.join(', ')} (default: none)"
     def init
       path = Pathname(options[:config] || ConfigLoader::FILENAME).expand_path
       raise Error, "#{path} already exists (use --force to overwrite)" if path.file? && !options[:force]
 
-      initializer = Initializer.new(dir: path.dirname)
+      initializer = Initializer.new(dir: path.dirname, template: options[:template])
       path.write(initializer.call)
       warn "wip: wrote #{path} (mode: #{initializer.compose? ? 'compose-native' : 'container'})"
     end

data/lib/wip/initializer.rb

@@ -1,68 +1,61 @@
 # frozen_string_literal: true
 
+require 'pathname'
+
 module Wip
   # Builds a starter wip.yml. Detects an existing compose file next to the
   # target (the same filenames ComposeBridge auto-detects) to decide between
   # mode: compose-native and mode: container, since that's the one decision
   # `wip init` can't leave to a placeholder.
   class Initializer
-    # Shared across both templates: every sync.* key SyncSettings understands,
-    # commented out with its default/behavior so nothing has to be looked up
-    # in the README to customize the mirror.
-    SYNC_TEMPLATE = <<~YAML.chomp
-      sync: {} # optional; mirrors the source into a named volume instead of bind-mounting it live
-        # source: . # optional; host path to mirror (default: wip.yml directory)
-        # target: /app # optional; in-container path the mirror volume mounts at (default: workdir, else /app)
-        # mount: /host-src # optional; read-only host mount inside the container (default: /host-src)
-        # volume: app-src # optional; named volume that holds the mirrored tree (default: "<container>-src")
-        # delete: true # optional; rsync --delete so removals on the host are mirrored too (default: true)
-        # exclude: [] # optional; rsync --exclude patterns, e.g. ["node_modules", "*.log"]
-        # command: rsync # optional; mirror binary to shell out to (default: rsync)
-        # options: [] # optional; extra flags appended to the mirror command
-        # interval: 2 # optional; seconds between mirrors (default: 2)
-        # mode: exec # optional; exec (default, mirrors into the running container) | run (fresh container each mirror)
-        # image: # optional; image the mirror container runs (required under mode: compose unless build: is set)
-        # build: # optional; let wip build a small dedicated mirror image instead of requiring one to exist
-        #   dockerfile: # TODO required if build: is set
-        #   tag: # optional (default: wip-sync-<container>:latest)
-    YAML
-
-    CONTAINER_TEMPLATE = <<~YAML.freeze
-      version: 1
-      mode: container # container | compose | compose-native (see README)
-      container: app # TODO: rename freely, as long as it matches a key under dependencies: below
-
-      # wslc: {} # optional; override which wslc binary/path wip shells out to (default: auto)
-      #   command: auto
-
-      # network: my-network # optional; container network name (mode: container only)
-
-      dependencies:
-        app: # this is the container wip creates, execs into, and runs commands in
-          image: your/image:tag # TODO: image to run
-          workdir: /app # TODO: adjust to match your image, or delete this line
-          # interactive: false # optional; keep stdin open / allocate a tty (default: false)
-          # remove: true # optional; remove the container after each run (default: true)
-          # env: {} # optional; environment variables passed to the container, e.g. {FOO: bar}
-          # ports: [] # optional; published ports, e.g. ["3000:3000"]
-          # volumes: [] # optional; extra -v specs beyond the source/sync mounts
-
+    # --template values wip init accepts, and the label used in the exclude: comment.
+    TEMPLATE_LABELS = {
+      'rails' => 'Rails',
+      'node' => 'Node.js',
+      'rust' => 'Rust',
+      'csharp' => 'C#'
+    }.freeze
+
+    # sync.exclude patterns written live for each --template. They mirror that
+    # stack's own github/gitignore template — directories that are either
+    # regenerated inside the container or too large/irrelevant to mirror over rsync.
+    TEMPLATE_EXCLUDES = {
+      'rails' => %w[.git log/ tmp/ storage/ public/assets/ public/packs/ .bundle/ vendor/bundle/
+                    coverage/ node_modules/],
+      'node' => %w[.git node_modules/ dist/ build/ .next/ .cache/ coverage/],
+      'rust' => %w[.git target/],
+      'csharp' => %w[.git bin/ obj/ .vs/ packages/]
+    }.freeze
+
+    # Used when --template is omitted — the same starting point the README's own
+    # example uses.
+    FALLBACK_EXCLUDES = %w[.git tmp/ node_modules/].freeze
+
+    # Appended to both templates after dependencies/compose. commands: itself is left
+    # commented since an empty commands: {} is indistinguishable from omitting the key.
+    COMMANDS_EXAMPLE = <<~YAML.chomp
+      # optional; custom subcommands, e.g. `wip test` — see README
       # commands:
-      #   test: # example custom command, invoked as `wip test`
-      #     type: exec # optional; exec (default, runs in the running container) | run (fresh container) | build
-      #     command: bundle exec rspec # TODO
+      #   test:
+      #     optional; exec (default, runs in the running container) | run (fresh container) | build
+      #     type: exec
 
-      #{SYNC_TEMPLATE}
+      #     TODO
+      #     command: bundle exec rspec
     YAML
 
-    def initialize(dir: Dir.pwd)
+    def initialize(dir: Dir.pwd, template: nil)
+      raise Error, "unknown --template #{template.inspect} (valid: #{TEMPLATE_LABELS.keys.join(', ')})" \
+        if template && !TEMPLATE_LABELS.key?(template)
+
       @dir = dir
+      @template = template
     end
 
     def compose? = !!compose_file
 
     def call
-      compose? ? compose_template : CONTAINER_TEMPLATE
+      compose? ? compose_template : container_template
     end
 
     private
@@ -71,28 +64,161 @@ module Wip
       @compose_file ||= ComposeBridge::FILENAMES.find { |name| File.file?(File.join(@dir, name)) }
     end
 
+    # Directory name wip.yml would resolve as its default compose.project (and, from
+    # that, its network name) if left unset — shown as a comment so it's discoverable
+    # without duplicating it as a live value that would go stale if the directory moves.
+    def compose_project_default = Pathname(@dir).basename.to_s
+
+    def exclude_comment
+      if @template
+        "# optional; rsync --exclude patterns picked for --template #{@template} (#{TEMPLATE_LABELS[@template]})"
+      else
+        '# optional; rsync --exclude patterns, e.g. ["node_modules", "*.log"]'
+      end
+    end
+
+    def exclude_list
+      patterns = @template ? TEMPLATE_EXCLUDES.fetch(@template) : FALLBACK_EXCLUDES
+      patterns.map { |pattern| "  - #{pattern}" }.join("\n")
+    end
+
+    # Appended to sync: in both templates. Every key here is either a plain constant
+    # default (safe to state literally) or, where commented, a value SyncSettings
+    # derives from another key (target from workdir, volume from the container/service
+    # name) — those stay unset so they keep tracking that key instead of going stale.
+    # A blank line separates every key from its neighbor; the gsub only indents
+    # non-blank lines so those separators stay actual blank lines, not trailing
+    # whitespace.
+    def sync_extras
+      <<~YAML.chomp.gsub(/^(?=.)/, '  ')
+        # optional; host path to mirror (default: wip.yml directory)
+        source: .
+
+        # optional; in-container mount point for the mirror (default: the container's workdir, else /app)
+        # target: /app
+
+        # optional; read-only host mount inside the container
+        mount: /host-src
+
+        # optional; named volume holding the mirrored tree (default: "<container>-src")
+        # volume: app-src
+
+        # optional; rsync --delete so removals on the host are mirrored too
+        delete: true
+
+        #{exclude_comment}
+        exclude:
+        #{exclude_list}
+
+        # optional; mirror binary to shell out to
+        command: rsync
+
+        # optional; extra flags appended to the mirror command
+        options: []
+
+        # optional; seconds between mirrors
+        interval: 2
+
+        # optional; exec (default, mirrors into the running container) | run (always a fresh container)
+        mode: exec
+
+        # only needed if sync.mode: run (or under mode: compose); image the mirror container runs
+        # image: your/image:tag
+
+        # alternative to image — let wip build a small dedicated mirror image itself
+        # build:
+        #   dockerfile: |
+        #     FROM alpine:latest
+        #     RUN apk add --no-cache rsync
+
+        #   optional (default: wip-sync-<container>:latest)
+        #   tag: wip-sync-app:latest
+      YAML
+    end
+
+    def container_template
+      <<~YAML
+        version: 1
+
+        # container | compose | compose-native (see README)
+        mode: container
+
+        # TODO: rename freely, as long as it matches a key under dependencies: below
+        container: app
+
+        wslc:
+          # optional; wslc binary/path wip shells out to ("auto" resolves it for you)
+          command: auto
+
+        # optional; container network name (mode: container only)
+        # network: my-network
+
+        dependencies:
+          # this is the container wip creates, execs into, and runs commands in
+          app:
+            # TODO: image to run
+            image: your/image:tag
+
+            # TODO: adjust to match your image, or delete this line
+            workdir: /app
+
+            # optional; keep stdin open / allocate a tty
+            interactive: false
+
+            # optional; remove the container after each run
+            remove: true
+
+            # optional; environment variables passed to the container, e.g. {FOO: bar}
+            env: {}
+
+            # optional; published ports, e.g. ["3000:3000"]
+            ports: []
+
+            # optional; extra -v specs beyond the sync mounts below
+            volumes: []
+
+        #{COMMANDS_EXAMPLE}
+
+        # optional; mirrors the source into a named volume instead of bind-mounting it live
+        sync:
+        #{sync_extras}
+      YAML
+    end
+
     def compose_template
       <<~YAML
         version: 1
-        mode: compose-native # wip parses #{compose_file} itself and drives wslc directly — no external
-                              # compose-for-wslc binary needed. Prefer a real compose tool instead? Use
-                              # mode: compose (see README "Compose mode") and set compose.command.
 
-        # wslc: {} # optional; override which wslc binary/path wip shells out to (default: auto)
-        #   command: auto
+        # wip parses #{compose_file} itself and drives wslc directly — no external
+        # compose-for-wslc binary needed. Prefer a real compose tool instead? Use
+        # mode: compose (see README "Compose mode") and set compose.command.
+        mode: compose-native
+
+        wslc:
+          # optional; wslc binary/path wip shells out to ("auto" resolves it for you)
+          command: auto
 
         compose:
-          service: app # TODO: which service in #{compose_file} wip run/exec/NAME target
-          # file: #{compose_file} # optional; override which compose file to parse (default: auto-detected)
-          # project: # optional; project/network name (default: wip.yml directory name)
-          # command: # required under mode: compose (external compose-for-wslc binary); unused under compose-native
+          # TODO: which service in #{compose_file} wip run/exec/NAME target
+          service: app
+
+          # optional; override which compose file wip parses (default: auto-detected)
+          # file: #{compose_file}
+
+          # optional; project/network name (default: this directory's name)
+          # project: #{compose_project_default}
+
+          # only used under mode: compose (external compose-for-wslc binary); unused here under compose-native
+          # command:
+
+        # network: is derived from compose.project above (or this directory's name) — setting it
+        # directly conflicts with compose: (ConfigError), so it's intentionally left out here.
 
-        # commands:
-        #   test: # example custom command, invoked as `wip test`
-        #     type: exec # optional; exec (default, runs in the running container) | run (fresh container) | build
-        #     command: bundle exec rspec # TODO
+        #{COMMANDS_EXAMPLE}
 
-        #{SYNC_TEMPLATE}
+        # optional; mirrors the source into a named volume instead of bind-mounting it live
+        sync:
+        #{sync_extras}
       YAML
     end
   end

data/lib/wip/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Wip
-  VERSION = '0.14.1'
+  VERSION = '0.15.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: wslc-wip
 version: !ruby/object:Gem::Version
-  version: 0.14.1
+  version: 0.15.0
 platform: ruby
 authors:
 - Wip contributors