captive-stack-detector 0.6.0 → 0.6.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 6f6cc07b2aebaa064c700e3efc99f2e9c08dc9cd9682206b66f6dacbcdaef476
4
- data.tar.gz: eeadaa4880a5673b9b89545333cd71895be4a8f04e6ab9503ce57d6051ce7416
3
+ metadata.gz: 487472525c07acc23f340602eca8aae3b4ef8d98c88a80e37d25f5802a45df1e
4
+ data.tar.gz: c18427405c1190c106b75eb64b082943e54e703d43fa17b5b340f639668d6321
5
5
  SHA512:
6
- metadata.gz: 7940bd96414ba39c325e183e898c9135e63cafca546c0189690846b5881d02fa5271358608d7d0055f240e2fa7267e0837b1b8cc51a3dc1ba3abb4172394c43c
7
- data.tar.gz: a646c1aebebdc27038f703f2ac779e764d1120e00c493a75dda43b1f717de7cb80f620d91997ed2263ca92c0c39750857bfcb318e685b037383ed19980e5f72f
6
+ metadata.gz: 8bebc550e548d55b8f50c87eb781f9954086b574602c51d494585bc7d519d391fedc905cc74c802033b77f8940f718431b6452bf8e06d860e4f9aa775460baeb
7
+ data.tar.gz: e1f7a93e4bb0e747537139c047d75789b89b0c85232951b807a4ab93b918e43851c8bc0d85ba8fe84972a676775e673ae6611b2be27956abb9ed287b5bc15418
data/docs/stacks.md ADDED
@@ -0,0 +1,88 @@
1
+ # Stacks supportées
2
+
3
+ Quand vous créez une application, Captive lit votre dépôt GitHub pour savoir **comment le construire et le lancer**. Cette famille de déploiement s'appelle la **stack**. Captive en connaît trois : **Rails**, **Node** et **Expo**. Si votre dépôt n'entre dans aucune, la création est refusée avec la raison exacte.
4
+
5
+ Captive ne lit que **la racine du dépôt** : un `Gemfile` ou un `package.json` placé dans un sous-dossier n'est pas vu.
6
+
7
+ ## Rails
8
+
9
+ Condition : un `Gemfile` à la racine qui contient la gem `rails`.
10
+
11
+ ```ruby
12
+ gem "rails", "8.1.0"
13
+ ```
14
+
15
+ - Avec une gem d'assets (`propshaft`, `sprockets-rails`, `importmap-rails`, `jsbundling-rails`, `cssbundling-rails`, `tailwindcss-rails`…), l'application est construite avec ses assets frontend.
16
+ - Sans gem d'assets, elle est construite comme une API.
17
+ - `gem "pg"` provisionne une base Postgres, `gem "redis"` ou `gem "sidekiq"` un Redis.
18
+
19
+ Si un `Gemfile` est présent, c'est toujours lui qui décide : un dépôt avec un `Gemfile` sans Rails est refusé, même s'il a aussi un `package.json`.
20
+
21
+ ## Node
22
+
23
+ Condition : un `package.json` à la racine, sans dépendance `expo`, avec un script **`start`** ou **`build`**.
24
+
25
+ ### Application web (SPA : Vite, React, Vue…)
26
+
27
+ Votre application est buildée une fois, puis servie en fichiers statiques. Aucun process Node ne tourne en production.
28
+
29
+ ```json
30
+ {
31
+ "scripts": {
32
+ "dev": "vite",
33
+ "build": "vite build"
34
+ },
35
+ "devDependencies": {
36
+ "vite": "7.1.0"
37
+ }
38
+ }
39
+ ```
40
+
41
+ - Le script `build` doit produire le dossier **`dist/`** à la racine. C'est le comportement par défaut de Vite ; si vous avez changé `build.outDir`, remettez `dist`.
42
+ - Toutes les routes inconnues renvoient `index.html` : le routage côté client (React Router, Vue Router…) fonctionne sans configuration.
43
+ - Les variables d'environnement sont injectées **au moment du build** (par exemple `VITE_SUPABASE_URL`). Après en avoir modifié une, redéployez.
44
+
45
+ ### Serveur Node (Next.js, Nuxt, SvelteKit, Remix)
46
+
47
+ Si votre `package.json` dépend de `next`, `nuxt`, `@sveltejs/kit` ou d'un paquet `@remix-run/…`, Captive lance un vrai serveur Node avec votre script `start`.
48
+
49
+ ```json
50
+ {
51
+ "scripts": {
52
+ "build": "next build",
53
+ "start": "next start"
54
+ },
55
+ "dependencies": {
56
+ "next": "15.0.0"
57
+ }
58
+ }
59
+ ```
60
+
61
+ ### Services
62
+
63
+ - `pg` ou `postgres` provisionne une base Postgres.
64
+ - `redis` ou `ioredis` provisionne un Redis.
65
+ - `@supabase/supabase-js` ou `@supabase/ssr` provisionne un backend Supabase.
66
+ - Une ligne `worker: <commande>` dans un `Procfile` lance un worker.
67
+
68
+ ## Expo
69
+
70
+ Condition : un `package.json` à la racine avec la dépendance `expo` (dans `dependencies` ou `devDependencies`). Aucun script n'est exigé.
71
+
72
+ ```json
73
+ {
74
+ "dependencies": {
75
+ "expo": "54.0.0"
76
+ }
77
+ }
78
+ ```
79
+
80
+ ## Ma création est refusée
81
+
82
+ | Message | Cause | Que faire |
83
+ | --- | --- | --- |
84
+ | Aucun Gemfile ni package.json à la racine du dépôt. | Pas de fichier de dépendances à la racine. | Vérifiez que l'application est bien à la racine du dépôt, pas dans un sous-dossier (`app/`, `frontend/`…). Les monorepos ne sont pas pris en charge. |
85
+ | Gemfile trouvé, mais sans la gem rails. | Application Ruby non Rails (Sinatra, Hanami…), ou `Gemfile` d'outillage dans un projet JavaScript. | Seul Rails est pris en charge côté Ruby. Si le `Gemfile` ne sert qu'à de l'outillage, retirez-le du dépôt. |
86
+ | package.json trouvé, mais sans dépendance expo ni script start ou build. | Captive ne sait pas comment construire l'application. | Ajoutez un script `build` (application web) ou `start` (serveur), comme dans les exemples ci-dessus. |
87
+
88
+ Si votre stack n'est pas listée ici, contactez l'équipe Captive.
@@ -1,5 +1,5 @@
1
1
  # frozen_string_literal: true
2
2
 
3
3
  module CaptiveStackDetector
4
- VERSION = "0.6.0"
4
+ VERSION = "0.6.1"
5
5
  end
@@ -8,6 +8,9 @@ require_relative "captive_stack_detector/rails_stack_detector"
8
8
  require_relative "captive_stack_detector/js_stack_detector"
9
9
 
10
10
  module CaptiveStackDetector
11
+ # Doc publique des stacks supportées, livrée dans la gem et affichée par le dashboard (ADR 0003).
12
+ DOC_PATH = File.expand_path("../docs/stacks.md", __dir__)
13
+
11
14
  def self.detect(local_path: nil, github_token: nil, repo: nil)
12
15
  reader = FileReader.build(local_path: local_path, github_token: github_token, repo: repo)
13
16
  detect_from(reader)
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: captive-stack-detector
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.6.0
4
+ version: 0.6.1
5
5
  platform: ruby
6
6
  authors:
7
7
  - Captive Studio
@@ -17,6 +17,7 @@ executables: []
17
17
  extensions: []
18
18
  extra_rdoc_files: []
19
19
  files:
20
+ - docs/stacks.md
20
21
  - lib/captive/stack/detector.rb
21
22
  - lib/captive_stack_detector.rb
22
23
  - lib/captive_stack_detector/aptfile_parser.rb