svelte-on-rails 0.0.45 → 1.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6ff301ac1c131b28f869668ca522cef6127e3d0946ed87b41da478555048fd8e
-  data.tar.gz: 4acb430643e3b6962c595299e2265c7c1075eb11c65eccb08b0fbc7ccc08e6b5
+  metadata.gz: bc4a6377868a5a06f7160c6e9a543ce94fbff469a3152051a9ac4091f37e3659
+  data.tar.gz: 2b451e6217380df53a0f1163347e320ea932386c6ba794916dd2edc07e2de037
 SHA512:
-  metadata.gz: 67fc3e82acf84cf6e09a4eded78d0ab8cd74b4bee8b92a91438382205e4f81c6f4fa5f443c6e4ba06ba935ae7799e1ea3a7fe3e26c9306ec7a8696766162526a
-  data.tar.gz: f6f4564ded3293a4e6b37b65bf1557b88f69faba8e9ae0c7b857921b3733b73f144924ce81456b857d437dc0e9bf049ef174d1dd799355ba031e448514528690
+  metadata.gz: 1bc7158bcec98b8566f280e8f2034d58d3f1bc64257ac7a54919c3e7247e8068ac282fabfdfa370422cd61173d780ef62be130b38dab290b5f73d8a050807723
+  data.tar.gz: 2504cdf6ada8a93a69dd67bd9b56fb54f1d6260d909ec91437b08df16af705700425194fd65ad56f83a990427b023b52f3cc8ed03421a0bda1b0622332454b68

data/README.md

@@ -1,6 +1,6 @@
 # Svelte on Rails
 
-Seamless and robust Svelte in Rails integration.
+Seamless and rock-solid integration of Svelte Components into Rails views, based on `vite_rails`.
 
 By default, and when installed together with `@hotwired/turbo-rails`, it renders
 svelte components on the first request server side («SSR») and for subsequent
@@ -11,14 +11,12 @@ This way svelte works perfectly together with turbo. You will never notice
 this unpleasant «blink» on the frontend and is optimised for maximum 
 performance. SSR compilation is done by vite.
 
-All this is developed on Rails-7 together with `vite_rails`.
-
 Thanks to [shakacode](https://github.com/shakacode/react_on_rails)
 and [ElMassimo](https://github.com/ElMassimo) for inspiring and helping me with their gems.
 
 **STATUS** This gem is in early development but ready to use for curious developers.
-It has a 100% test coverage, all tests pass when triggered indiviudally.
-Running all tests together fails for some tests (ToDo).
+It has a 100% test coverage, all tests pass. 
+It is not yet implemented on my customer projects, but this will follow soon.
 
 If you have issues, please open one and contributors are welcome!
 
@@ -34,9 +32,7 @@ If you have issues, please open one and contributors are welcome!
 
 ## Installation from cero
 
-together with haml, vite, svelte and turbo
-
-If you want to start from a new rails app, follow theese tutorials
+With haml, vite, svelte and turbo:
 
 ```bash
 rails new my-test-app --skip-javascript
@@ -75,14 +71,17 @@ And there is the option `--force` that would not ask you whether it should overw
 This means, if you want all, except haml, you can run:
 
 ```bash
-rails g svelte_on_rails:install --vite --turbo --svelte --hello-world --force
+rails g svelte_on_rails:install --vite --turbo --svelte --hello-world
 ```
 
-The installer is written carefully: It does not overwrite a file without asking.
-It tells you all what he is doing.
+The installer is written carefully: It does not overwrite a file without asking
+and tells you all what he is doing.
 
 At the end, you just have to (re-) start your server
-and you will see a Svelte component.
+and you will see a Svelte Hello World component.
+
+This hello world has a second page where the most common import statements are demonstrated,
+separated for server and client side rendering.
 
 Then, you can run
 
@@ -120,12 +119,13 @@ Both should return the same html. And your global styles should be applied same
 for both cases. For 95% of use cases this is the case. 
 
 For check the **ssr pipeline** you can pass the options `ssr: true` and `hydrate: false`
-to the view helper. That Way you will see a dead html (no javascript is working).
+to the view helper. This way you will see a «dead» html (no javascript is working).
 
 For check the **client side pipeline** you can pass the option `ssr: false` and
 `hydrate: true` to the view helper.
 
-If both are looking similar, you are good to go.
+If both are looking similar, you are good to go. Then, remove theese options, the defaults are
+`ssr: :auto` and `hydrate: true`.
 
 ### Import statements
 
@@ -191,19 +191,28 @@ rails svelte_on_rails:remove_hello_world
 
 Contributors welcome!
 
-After downloaded the gem, please run the task
+**Download the code and run the tests**
+
+Download the source code from the repository, and within the project folder run:
 
 ```bash 
 rake svelte_on_rails:create_contributor_configs_file
 ```
 and define a `generated_test_app_folder_path` (required) for apps, generated for the testings.
 
-For development of the **npm package @csedl/svelte-on-rails** you can set the
-`local_npm_package_path` (optional) and insert the path to the npm package on your local machine.
+For development of the **npm package @csedl/svelte-on-rails** (optional) please download the source code of the
+npm package and set
+`local_npm_package_path` and set the path to the npm package on your local machine.
 This will cause the installer, to install the npm package from a local path instead from the npm registry.
 
+Then run the tests and start contributing.
+
 Tests are based on the included templates, like the `hello world template` and on the installer.
 
+Here I learned how to write tests! Testing installers is heavy, you will read about it in the
+test_helpers. But I have done my best to give all the code a clear structure.
+I hope you like it, and improvements are welcome.
+
 **Installer tests** starting with completely destroy the rails app within the `generated_test_app_path`,
 generating a new rails app and running the installer and test by `playwright` if the components are working.
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: svelte-on-rails
 version: !ruby/object:Gem::Version
-  version: 0.0.45
+  version: 1.0.1
 platform: ruby
 authors:
 - Christian Sedlmair
@@ -95,5 +95,6 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 rubygems_version: 3.6.7
 specification_version: 4
-summary: Seamlessly integrate Svelte Components into Rails views.
+summary: Seamless and rock-solid integration of Svelte Components into Rails views,
+  based on vite_rails.
 test_files: []