solidus_admin 0.0.2 → 0.1.0

data/config/solidus_admin/tailwind.config.js.erb

@@ -1,95 +0,0 @@
-const defaultTheme = require('tailwindcss/defaultTheme')
-const plugin = require('tailwindcss/plugin')
-
-module.exports = {
-  content: [
-    <%= SolidusAdmin::Config.tailwind_content.map { "'#{_1}'" }.join(",\n    ") %>
-  ],
-  theme: {
-    extend: {
-      aria: {
-        'current': 'current="true"',
-      },
-      fontFamily: {
-        sans: ['Inter var', ...defaultTheme.fontFamily.sans],
-      },
-      colors: {
-        transparent: "transparent",
-        current: "currentColor",
-
-        // Primary palette
-        solidusRed: "#ef3023",
-        black: "#222222",
-        graphite: "#c7ccc7",
-        graphiteLight: "#d8dad8",
-        sand: "#f5f3f0",
-        white: "#ffffff",
-
-        // Secondary palette
-        yellow: "#fdc071",
-        orange: "#f68050",
-        blue: "#2554b1",
-        moss: "#2d3925",
-        forest: "#096756",
-        midnight: "#163449",
-        pink: "#f6d7e2",
-        plum: "#3a0e31",
-        sky: "#cbdff1",
-        seafoam: "#c1e0de",
-        dune: "#e6bf9b",
-
-        // Extra colors (not part of the original palette)
-        papayaWhip: "#f9e3d9",
-
-        // UI Red
-        red: {
-          100: "#f8d6d3",
-          200: "#f1ada7",
-          300: "#ea8980",
-          400: "#e36054",
-          500: "#dc3728",
-          600: "#b12c20",
-          700: "#862219",
-          800: "#561610",
-          900: "#2b0b08",
-        },
-
-        // Grayscale
-        gray: {
-          15: "#fafafa",
-          25: "#f5f5f5",
-          50: "#f0f0f0",
-          100: "#dedede",
-          200: "#cfcfcf",
-          300: "#bababa",
-          400: "#a3a3a3",
-          500: "#737373",
-          600: "#616161",
-          700: "#4a4a4a",
-          800: "#333333",
-        },
-      },
-      borderRadius: {
-        sm: '4px',
-      },
-      backgroundImage: {
-        'arrow-right-up-line': "url('solidus_admin/arrow_right_up_line.svg')",
-        'arrow-down-s-fill-gray-700': "url('solidus_admin/arrow_down_s_fill_gray_700.svg')",
-        'arrow-down-s-fill-red-400': "url('solidus_admin/arrow_down_s_fill_red_400.svg')",
-      },
-      boxShadow: {
-        sm: '0px 1px 2px 0px rgba(0, 0, 0, 0.04)',
-        base: '0px 4px 8px 0px rgba(0, 0, 0, 0.08), 0px 2px 4px -1px rgba(0, 0, 0, 0.04)'
-      },
-    },
-  },
-  plugins: [
-    require('@tailwindcss/forms')({ strategy: 'class' }),
-    require('@tailwindcss/aspect-ratio'),
-    require('@tailwindcss/typography'),
-    require('@tailwindcss/container-queries'),
-    plugin(({ addVariant }) => addVariant('hidden', '&([hidden])')),
-    plugin(({ addVariant }) => addVariant('visible', '&:not([hidden])')),
-    plugin(({ addVariant }) => addVariant('search-cancel', '&::-webkit-search-cancel-button')),
-  ]
-}

data/docs/customizing_tailwind.md

@@ -1,78 +0,0 @@
-# Customizing tailwind
-
-Solidus Admin uses [Tailwind CSS](https://tailwindcss.com/) for styling. The
-benefit of using Tailwind is that it allows you to customize the look and feel
-of the admin without having to write any CSS. By leveraging utility classes,
-you can easily change the colors, fonts, and spacing in use.
-
-Solidus Admin sets up Tailwind in a way that allows customization. When you
-install `solidus_admin`, its compiled CSS file is generated at
-`app/assets/builds/solidus_admin/tailwind.css`. As we'll see below, there are
-different ways in which you can add your styles to it. There are a couple of
-tasks you can run to recompile the CSS file:
-
-- `bin/rails solidus_admin:tailwindcss:build` - compiles the CSS file once.
-- `bin/rails solidus_admin:tailwindcss:watch` - compiles the CSS file and
-  watches for changes.
-
-When deploying to production, the build task is automatically added as part of
-the assets precompilation process.
-
-### Adding new paths to Tailwind
-
-Tailwind generates its CSS by scanning a configured set of paths for CSS
-classes. By default, Solidus Admin will add to this list the following globs
-from your host application:
-
-- `app/components/solidus_admin/**/*.rb`
-- `app/views/solidus_admin/**/*.{erb,haml,html,slim}`
-- `app/helpers/solidus_admin/**/*.rb`
-- `app/assets/javascripts/solidus_admin/**/*.js`
-- `public/solidus_admin/*.html`
-
-If that flexibility is not enough, you can add your own paths by appending the
-`SolidusAdmin::Config.tailwind_content` setting:
-
-```ruby
-# config/initializers/solidus_admin.rb
-SolidusAdmin::Config.tailwind_content << Rails.root.join("app/my/custom/path/**/*.rb")
-```
-
-> ⚠ Remember to re-run the `build` or `watch` tasks after changing this setting.
-
-### Adding custom CSS
-
-If you need advanced Tailwind customization, you can also create your own CSS
-file and append it to the Solidus Admin's default one. Be aware that's
-[considered a last-resort option](https://tailwindcss.com/docs/reusing-styles)
-according to Tailwind's philosophy, and most of the time you should be ok by
-making use of the available Tailwind classes.
-
-In case you need to do it, you can append your CSS file by pushing it to the
-`SolidusAdmin.tailwind_stylesheets` array:
-
-```ruby
-# config/initializers/solidus_admin.rb
-SolidusAdmin.tailwind_stylesheets << Rails.root.join("app/my/custom/path/my_styles.css")
-```
-
-> ⚠ Remember to re-run the `build` or `watch` tasks after changing this setting.
-
-## Acquiring full control over Tailwind configuration
-
-For very advanced use cases, it's possible to bail out of the Solidus Admin's
-managed Tailwind configuration and get a grip on it yourself. This is not
-recommended, as it will make your app more brittle to future changes in Solidus
-Admin, so do it at your own risk!
-
-There are a couple of tasks you can run for that:
-
-- `bin/rails solidus_admin:tailwindcss:override_config` - copies the default
-  Tailwind configuration file to `config/solidus_admin/tailwind.config.js.erb`.
-- `bin/rails solidus_admin:tailwindcss:override_stylesheet` - copies the
-  default Tailwind stylesheet file to
-  `app/assets/stylesheets/solidus_admin/application.tailwind.css.erb`.
-
-Notice that, unlike in a regular Tailwind setup, the config and stylesheet
-files are ERB templates. This is because they need to be able to access the
-Solidus Admin and application paths.

data/lib/solidus_admin/tailwindcss.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-require "tailwindcss-rails"
-require "fileutils"
-
-module SolidusAdmin
-  # @api private
-  module Tailwindcss
-    module_function
-
-    def run(args = "")
-      config_file_path = compile_to_tempfile(
-        [config_app_path, config_engine_path].find(&:exist?),
-        "tailwind.config.js"
-      )
-      stylesheet_file_path = compile_to_tempfile(
-        [stylesheet_app_path, stylesheet_engine_path].find(&:exist?),
-        "application.tailwind.css"
-      )
-
-      system "#{::Tailwindcss::Engine.root.join('exe/tailwindcss')} \
-         -i #{stylesheet_file_path} \
-         -o #{Rails.root.join('app/assets/builds/solidus_admin/tailwind.css')} \
-         -c #{config_file_path} \
-         #{args}"
-    end
-
-    def config_app_path
-      Rails.root.join("config/solidus_admin/tailwind.config.js.erb")
-    end
-
-    def config_engine_path
-      SolidusAdmin::Engine.root.join("config/solidus_admin/tailwind.config.js.erb")
-    end
-
-    def stylesheet_app_path
-      Rails.root.join("app/assets/stylesheets/solidus_admin/application.tailwind.css.erb")
-    end
-
-    def stylesheet_engine_path
-      SolidusAdmin::Engine.root.join("app/assets/stylesheets/solidus_admin/application.tailwind.css.erb")
-    end
-
-    def compile_to_tempfile(erb_path, name)
-      Rails.root.join("tmp/solidus_admin/#{name}").tap do |file|
-        content = ERB.new(File.read(erb_path)).result
-
-        file.dirname.mkpath
-        file.write(content)
-      end
-    end
-
-    def copy_file(src, dst)
-      FileUtils.mkdir_p(File.dirname(dst))
-      FileUtils.cp(src, dst)
-    end
-  end
-end

data/lib/tasks/tailwindcss.rake

@@ -1,55 +0,0 @@
-# frozen_string_literal: true
-
-namespace :solidus_admin do
-  namespace :tailwindcss do
-    require "solidus_admin/tailwindcss"
-
-    desc "Build Solidus Admin's Tailwind's css"
-    task build: :environment do
-      SolidusAdmin::Tailwindcss.run
-    end
-
-    desc <<~DESC
-      Watch and build Solidus Admin's Tailwind css on file changes
-
-      It needs to be re-run whenever:
-
-      - `SolidusAdmin::Config.tailwind_content` is updated
-      - `SolidusAdmin::Config.tailwind_stylesheets` is updated
-      - `bin/rails solidus_admin:tailwindcss:override_config` is run
-      - `bin/rails solidus_admin:tailwindcss:override_stylesheet` is run
-      - The override files are updated
-    DESC
-    task watch: :environment do
-      SolidusAdmin::Tailwindcss.run("-w")
-    end
-
-    desc <<~DESC
-      Override Solidus Admin's Tailwindcss configuration
-
-      It copies the config file from the engine to the app, so it can be customized.
-    DESC
-    task override_config: :environment do
-      SolidusAdmin::Tailwindcss.copy_file(
-        SolidusAdmin::Tailwindcss.config_engine_path,
-        SolidusAdmin::Tailwindcss.config_app_path
-      )
-    end
-
-    desc <<~DESC
-      Override Solidus Admin's Tailwind's stylesheet
-
-      It copies the stylesheet file from the engine to the app, so it can be customized.
-    DESC
-    task override_stylesheet: :environment do
-      SolidusAdmin::Tailwindcss.copy_file(
-        SolidusAdmin::Tailwindcss.stylesheet_engine_path,
-        SolidusAdmin::Tailwindcss.stylesheet_app_path
-      )
-    end
-  end
-end
-
-if Rake::Task.task_defined?("assets:precompile")
-  Rake::Task["assets:precompile"].enhance(["solidus_admin:tailwindcss:build"])
-end