vite_rb 0.0.1.alpha1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4fdf3125edcc03c5871b2da86496aa4fb29f1915fbd9a617419231c3e49db2fd
+  data.tar.gz: 8d8d8aa54277af1f2943367e22955c1dca8fff13e5ec2d669901c1f668c4bca6
+SHA512:
+  metadata.gz: b14932e9e675dbbc27dfe0c8e50b590a882fa0a126e7dd2cc576bf67ba7f4581f64edc60fcc1a68d9fab6871f053b2b3274f0e62fd356b29002e8f24be8bbbe5
+  data.tar.gz: d2aee947f31f485c3d3fc6acc32690afaa86ee54dd4e333dae101f6f8198d0c87acea26abce0c905a8564b929bead29cc2ea25cdb564a44ff46a1ddbba47859a

data/.codeclimate.yml

@@ -0,0 +1,3 @@
+exclude_patterns:
+  - "examples/"
+  - "lib/snowpacker/templates/babel.config.js"

data/.dockerignore

@@ -0,0 +1,22 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+public/
+.cache/
+
+log/
+
+node_modules/
+
+.vscode/
+/tags
+/examples

data/.github/FUNDING.yml

@@ -0,0 +1 @@
+github: ParamagicDev

data/.github/workflows/build.yml

@@ -0,0 +1,17 @@
+name: Run tests
+on: [push, pull_request]
+jobs:
+  test:
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu, macos, windows]
+        ruby: [2.5, 2.6, 2.7, head]
+    runs-on: ${{ matrix.os }}-latest
+    steps:
+    - uses: actions/checkout@v2
+    - uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: ${{ matrix.ruby }}
+        bundler-cache: true # runs 'bundle install' and caches installed gems automatically
+    - run: bundle exec rake test

data/.gitignore

@@ -0,0 +1,71 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+
+public/
+.cache/
+
+log/
+
+*node_modules*
+
+.vscode/
+tags
+
+# See https://help.github.com/articles/ignoring-files for more about ignoring files.
+#
+# If you find yourself ignoring temporary files generated by your text editor
+# or operating system, you probably want to add a global ignore instead:
+#   git config --global core.excludesfile '~/.gitignore_global'
+
+# Ignore bundler config.
+.bundle
+
+# Ignore the default SQLite database.
+examples/*/db/*.sqlite3
+examples/*/db/*.sqlite3-journal
+examples/*/db/*.sqlite3-*
+
+# Ignore all logfiles and tempfiles.
+examples/**/*log/
+examples/**/*tmp
+!examples/**/*log/.keep
+!examples/**/*tmp/.keep
+
+# Ignore pidfiles, but keep the directory.
+examples/*/tmp/pids/*
+!examples/*/tmp/pids/
+!examples/*/tmp/pids/.keep
+
+# Ignore uploaded files in development.
+examples/*/storage/*
+!examples/*/storage/.keep
+
+examples/*/public/assets
+examples/*/.byebug_history
+
+# Ignore master key for decrypting credentials and more.
+examples/*/config/master.key
+
+examples/**/*tmp
+examples/**/public/snowpacks
+examples/**/node_modules
+examples/**/yarn-error.log
+examples/**/yarn-debug.log*
+examples/**/.yarn-integrity
+examples/**/snowpacks
+
+test/**/*tmp
+test/**/*storage
+test/**/*node_modules
+test/**/*yarn-error.log
+package/dist
+Gemfile.lock

data/.ruby-version

@@ -0,0 +1 @@
+ruby-2.7.2

data/.solargraph.yml

@@ -0,0 +1,16 @@
+---
+include:
+- "**/*.rb"
+exclude:
+- spec/**/*
+- test/**/*
+- vendor/**/*
+- ".bundle/**/*"
+require: []
+domains: []
+reporters:
+- rubocop
+- require_not_found
+require_paths: []
+plugins: []
+max_files: 5000

data/.standard.yml

@@ -0,0 +1,11 @@
+fix: true               # default: false
+parallel: true          # default: false
+format: progress        # default: Standard::Formatter
+default_ignores: true  # default: true
+
+ignore:                 # default: []
+  - 'db/schema.rb'
+  - '**/*node_modules/**/*'
+  - 'vendor/**/*'
+  - 'test/**/*':
+    - Layout/AlignHash

data/CHANGELOG.md

@@ -0,0 +1,65 @@
+<a name="2020-07-27"></a>
+### 2020-07-27
+
+
+#### Bug Fixes
+
+* move detect_port! into dev command	 ([b93f029](/../../commit/b93f029))
+* add sourcing of docker.env	 ([66838ac](/../../commit/66838ac))
+
+
+<a name="2020-07-26"></a>
+### 2020-07-26
+
+
+#### Features
+
+* add postcss packages	 ([783adf8](/../../commit/783adf8))
+* allow for an encapsulated postcss & babel config	 ([f95e15a](/../../commit/f95e15a))
+* add @snowpack/babel-plugin-package-import for transforming imports	 ([596df4a](/../../commit/596df4a))
+* add postcss and babel config attrs to configuration	 ([f0d51b6](/../../commit/f0d51b6))
+* add @snowpack/plugin-babel to generator	 ([3a7d872](/../../commit/3a7d872))
+* generate configs with generator	 ([1906a31](/../../commit/1906a31))
+* add babel and postcss configs to templates	 ([a0b0ec4](/../../commit/a0b0ec4))
+
+
+#### Bug Fixes
+
+* **config**
+  * fix issue with configuration.rb, generate config	 ([3d6a8f1](/../../commit/3d6a8f1))
+
+* **generator**
+  * now properly generates files	 ([ba62564](/../../commit/ba62564))
+
+* use the preset node_env prior to setting one.	 ([abe788a](/../../commit/abe788a))
+* Env now respects user set env vars	 ([588b41f](/../../commit/588b41f))
+
+
+<a name="2020-07-24"></a>
+### 2020-07-24
+
+
+#### Features
+
+* add an example of using stylesheet link tags	 ([889f241](/../../commit/889f241))
+* add a mount directory configuration	 ([c8556d7](/../../commit/c8556d7))
+* add a compile rake task	 ([607ef29](/../../commit/607ef29))
+* updating templates	 ([e126948](/../../commit/e126948))
+* rewrite snowpack.config to js format	 ([e6f89aa](/../../commit/e6f89aa))
+* allow users to define a hostname and port	 ([95ff03b](/../../commit/95ff03b))
+* add rack-proxy for proxy requests	 ([8635324](/../../commit/8635324))
+* add snowpacks to example directory	 ([bb3f1e9](/../../commit/bb3f1e9))
+* have the runner specify a node_env	 ([5f97e9a](/../../commit/5f97e9a))
+* modify generators and update readme	 ([a305177](/../../commit/a305177))
+* Add a prior-to-install directory	 ([fbca36d](/../../commit/fbca36d))
+* add docker	 ([945d27b](/../../commit/945d27b))
+
+#### Bug Fixes
+
+* gitignore to ignore node_modules	 ([e1ee78d](/../../commit/e1ee78d))
+* remove parcel-bundler, remove .travis.yml	 ([08ecb2a](/../../commit/08ecb2a))
+
+* **gitignore**
+  * ignore tags	 ([890ce35](/../../commit/890ce35))
+
+

data/Gemfile

@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in snowpacker.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 Michał Darda
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,258 @@
+# Vite
+
+## WORK IN PROGRESS
+
+If you would like to help support the future of this project,
+please consider sponsoring me so I can keep a regular stream
+of updates and fixes to this project.
+
+https://github.com/sponsors/ParamagicDev
+
+Please note, that this project is still in it's infancy. Feel free to
+file bug reports, issues, and feature requests.
+
+[![Gem Version](https://badge.fury.io/rb/vite_rb.svg)](https://badge.fury.io/rb/vite_rb)
+
+<!-- [![Maintainability](https://api.codeclimate.com/v1/badges/b88ac1a56d868d4f23d5/maintainability)](https://codeclimate.com/github/ParamagicDev/vite_rb/maintainability) -->
+
+This gem integrates the [Vite](https://vitejs.dev/) JS module bundler into
+your Rails / Ruby application. It is inspired by gems such as
+[breakfast](https://github.com/devlocker/breakfast) /
+[webpacker](https://github.com/rails/webpacker) and this project started
+as a fork of
+[Vite](https://github.com/ParamagicDev/vite_rb).
+
+This is not meant to be a 1:1 replacement of Webpacker. ViteRb is
+actually just a wrapper around Vite using Rake / Thor and as a result can
+be used with any Rack based framework. Vite comes with first class
+support for Rails including Generators and autoloaded helpers.
+
+## How is Vite different?
+
+Vite is unbundled during development to eliminate compilation
+times. Asset requests are cached with 304 headers. Bundling is saved for the final build process due to waterfall
+network requests that still cause some issues in production and can
+cause significant slowdown.
+
+Vite uses the native ESM module spec. ESM Modules are fast,
+lightweight, and natively supported by all newer browsers ("evergreen browsers")
+For more reading on ESM modules, check out this link:
+
+[https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules)
+
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'vite_rb', git: "https://github.com/ParamagicDev/vite_rb"
+```
+
+### With Rails
+
+```bash
+rails vite:init
+```
+
+Which will install your yarn packages, create an initializer file, add config files, and create an `app/vite` directory similar to Webpacker.
+
+#### Tasks
+
+```bash
+rails vite:dev # starts a dev server
+rails vite:build # builds for production (is hooked onto
+precompile)
+rails assets:precompile # will build vite and the asset pipeline
+```
+
+#### Existing Rails app
+
+When working with a new Rails app, it is important to switch any webpack
+`require` statements to ESM-based `import`. For example, consider the
+following javascript file:
+
+```diff
+// app/javascript/packs/application.js
+
+- // Webpack
+- require("@rails/ujs").start()
+- require("turbolinks").start()
+- require("@rails/activestorage").start()
+- require("channels")
+-
++ // app/vite/entrypoints/applications.js
++ import "@rails/ujs" // Autostarts
++ import Turbolinks from "turbolinks"
++ import ActiveStorage from "@rails/activestorage"
++ import "../channels"
++
++ Turbolinks.start()
++ ActiveStorage.start()
+```
+
+You may notice a `require.context` statement in your javascript to load
+`channels`. This runs via Node and is not browser compatible. Vite comes
+with a glob import syntax, you can read about it here: @TODO
+
+```diff
+// app/javascript/channels/index.js
+
+// Load all the channels within this directory and all subdirectories.
+// Channel files must be named *_channel.js.
+
+- const channels = require.context('.', true, /_channel\.js$/)
+- channels.keys().forEach(channels)
+// @TODO
+```
+
+## File Structure
+
+Vite makes some assumptions about your file paths to provide
+helper methods.
+
+```bash
+tree -L 2 app/vite
+
+app/vite/
+├── assets/
+│   └── picture.png
+├── channels/
+│   ├── consumer.js
+│   └── index.js
+├── entrypoints/
+│   └── application.js
+├── javascript/
+│   └── index.js
+└── stylesheets/
+    └── index.css
+```
+
+Which upon build will output to look like this:
+
+```bash
+tree -L 1 public/Vites
+
+public/vite/
+├── assets/
+├── channels/
+├── entrypoints/
+├── javascript/
+├── css/
+```
+
+## Helpers
+
+### Generic Helper
+
+`<%= vite_path %>` will return the value of
+`Vite.config.output_dir`
+
+### Assets
+
+Assets can be accessed via `<%= vite_asset_path("name", **options) %>` and accepts all
+the same params as [#asset_path](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetUrlHelper.html#method-i-asset_path)
+
+### Channels
+
+Channels have no special helper.
+
+### Packs
+
+Packs can be accessed via:
+
+`<%= javascript_vite_tag %>` and works the same as
+[`#javascript_include_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-javascript_include_tag)
+
+`packs` are your "entrypoints" and where files get bundled to, very
+similar to Webpacker.
+
+### Javascript
+
+Javascript files have no special helper.
+
+### Stylesheets
+
+Stylesheets can be accessed via:
+
+`<%= stylesheet_vite_tag %>` and works just like
+[`#stylesheet_link_tag`](https://api.rubyonrails.org/classes/ActionView/Helpers/AssetTagHelper.html#method-i-stylesheet_link_tag).
+I recommend importing your css in your `packs` file if you plan on
+changing it to support HMR.
+
+### HMR
+
+To enable HMR for your vite assets, put the following in the `<head>` of
+your document:
+
+`<%= vite_hmr_tag %>`
+
+## Configuration
+
+After running generator, the configuration file can be found in
+`config/initializers/vite.rb`
+
+In addition, all related `vite.config.js`, and
+`postcss.config.js` can all be found in the `config/vite`
+directory.
+
+## Production
+
+ViteRb hooks up to the `rails assets:precompile` and `rails
+assets:clobber`, so no special setup is required.
+
+You can start vite_rb's compilation process manually by running
+
+```bash
+rails vite:compile
+
+# OR
+
+rails vite:build
+```
+
+
+## Examples
+
+Examples can be found in the [/examples](/examples) directory.
+
+## Converting from Webpack to Snowpack
+
+- `require.context()` is not currently supported
+
+Instead, use the glob syntax from [Vite](https://vitejs.dev)
+
+## Issues
+
+Not all packages may be compatible with Vite. Please check
+[skypack.dev](https://skypack.dev) for ESM-compatible packages.
+
+## Changelog
+
+See [CHANGELOG.md](https://github.com/ParamagicDev/vite_rb/blob/master/CHANGELOG.md)
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ParamagicDev/vite_rb.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Roadmap
+
+- [ ] Add default file structure with init
+
+- [x] Support require.context (Glob importing supported by Vite)
+
+- [ ] Reading from production manifest
+
+- [ ] Parity with Webpacker helper methods
+
+- [ ] Add documentation / installation on Stimulus
+
+- [ ] Create an npm package to read a default config from and pin Vite versions
+
+- [ ] Add in End-to-end testing to confirm everything works as intended.
+
+- [ ] Make the config environment from NPM in Typescript so users can import types for good completion.