Initial commit

Alteras1 · web-flow · commit a8ae7cc887bf · 2025-02-23T22:11:54.000-08:00
diff --git a/.discourse-compatibility b/.discourse-compatibility
diff --git a/.github/workflows/discourse-plugin.yml b/.github/workflows/discourse-plugin.yml
@@ -0,0 +1,11 @@
+name: Discourse Plugin
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+jobs:
+  ci:
+    uses: discourse/.github/.github/workflows/discourse-plugin.yml@v1
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,3 @@
+node_modules
+/gems
+/auto_generated
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1,2 @@
+engine-strict = true
+auto-install-peers = false
diff --git a/.prettierrc.cjs b/.prettierrc.cjs
@@ -0,0 +1 @@
+module.exports = require("@discourse/lint-configs/prettier");
diff --git a/.rubocop.yml b/.rubocop.yml
@@ -0,0 +1,2 @@
+inherit_gem:
+  rubocop-discourse: stree-compat.yml
diff --git a/.streerc b/.streerc
@@ -0,0 +1,2 @@
+--print-width=100
+--plugins=plugin/trailing_comma,plugin/disable_auto_ternary
diff --git a/.template-lintrc.cjs b/.template-lintrc.cjs
@@ -0,0 +1 @@
+module.exports = require("@discourse/lint-configs/template-lint");
diff --git a/Gemfile b/Gemfile
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+group :development do
+  gem "rubocop-discourse"
+  gem "syntax_tree"
+end
diff --git a/Gemfile.lock b/Gemfile.lock
@@ -0,0 +1,87 @@
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (7.1.3.3)
+      base64
+      bigdecimal
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      connection_pool (>= 2.2.5)
+      drb
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      mutex_m
+      tzinfo (~> 2.0)
+    ast (2.4.2)
+    base64 (0.2.0)
+    bigdecimal (3.1.8)
+    concurrent-ruby (1.2.3)
+    connection_pool (2.4.1)
+    drb (2.2.1)
+    i18n (1.14.5)
+      concurrent-ruby (~> 1.0)
+    json (2.7.2)
+    language_server-protocol (3.17.0.3)
+    minitest (5.23.1)
+    mutex_m (0.2.0)
+    parallel (1.24.0)
+    parser (3.3.1.0)
+      ast (~> 2.4.1)
+      racc
+    prettier_print (1.2.1)
+    racc (1.8.0)
+    rack (3.0.12)
+    rainbow (3.1.1)
+    regexp_parser (2.9.2)
+    rexml (3.3.9)
+    rubocop (1.64.0)
+      json (~> 2.3)
+      language_server-protocol (>= 3.17.0)
+      parallel (~> 1.10)
+      parser (>= 3.3.0.2)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.31.3)
+      parser (>= 3.3.1.0)
+    rubocop-capybara (2.20.0)
+      rubocop (~> 1.41)
+    rubocop-discourse (3.8.0)
+      activesupport (>= 6.1)
+      rubocop (>= 1.59.0)
+      rubocop-capybara (>= 2.0.0)
+      rubocop-factory_bot (>= 2.0.0)
+      rubocop-rails (>= 2.25.0)
+      rubocop-rspec (>= 2.25.0)
+    rubocop-factory_bot (2.25.1)
+      rubocop (~> 1.41)
+    rubocop-rails (2.25.0)
+      activesupport (>= 4.2.0)
+      rack (>= 1.1)
+      rubocop (>= 1.33.0, < 2.0)
+      rubocop-ast (>= 1.31.1, < 2.0)
+    rubocop-rspec (2.29.2)
+      rubocop (~> 1.40)
+      rubocop-capybara (~> 2.17)
+      rubocop-factory_bot (~> 2.22)
+      rubocop-rspec_rails (~> 2.28)
+    rubocop-rspec_rails (2.28.3)
+      rubocop (~> 1.40)
+    ruby-progressbar (1.13.0)
+    syntax_tree (6.2.0)
+      prettier_print (>= 1.2.0)
+    tzinfo (2.0.6)
+      concurrent-ruby (~> 1.0)
+    unicode-display_width (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  rubocop-discourse
+  syntax_tree
+
+BUNDLED WITH
+   2.5.10
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) Civilized Discourse Construction Kit, Inc.
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,5 @@
+# **Plugin Name** Plugin
+
+**Plugin Summary**
+
+For more information, please see: **url to meta topic**
diff --git a/app/.gitkeep b/app/.gitkeep
diff --git a/app/controllers/my_plugin_module/examples_controller.rb b/app/controllers/my_plugin_module/examples_controller.rb
@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module ::MyPluginModule
+  class ExamplesController < ::ApplicationController
+    requires_plugin PLUGIN_NAME
+
+    def index
+      render json: { hello: "world" }
+    end
+  end
+end
diff --git a/assets/javascripts/.gitkeep b/assets/javascripts/.gitkeep
diff --git a/assets/stylesheets/.gitkeep b/assets/stylesheets/.gitkeep
diff --git a/config/locales/client.en.yml b/config/locales/client.en.yml
@@ -0,0 +1,9 @@
+en:
+  admin_js:
+    admin:
+      site_settings:
+        categories:
+          TODO_plugin_name: "Plugin Name"
+  js:
+    discourse_plugin_name:
+      placeholder: placeholder
diff --git a/config/locales/server.en.yml b/config/locales/server.en.yml
@@ -0,0 +1 @@
+en:
diff --git a/config/routes.rb b/config/routes.rb
@@ -0,0 +1,8 @@
+# frozen_string_literal: true
+
+MyPluginModule::Engine.routes.draw do
+  get "/examples" => "examples#index"
+  # define routes here
+end
+
+Discourse::Application.routes.draw { mount ::MyPluginModule::Engine, at: "my-plugin" }
diff --git a/config/settings.yml b/config/settings.yml
@@ -0,0 +1,4 @@
+TODO_plugin_name:
+  plugin_name_enabled:
+    default: false
+    client: true
diff --git a/db/.gitkeep b/db/.gitkeep
diff --git a/eslint.config.mjs b/eslint.config.mjs
@@ -0,0 +1,3 @@
+import DiscourseRecommended from "@discourse/lint-configs/eslint";
+
+export default [...DiscourseRecommended];
diff --git a/lib/my_plugin_module/engine.rb b/lib/my_plugin_module/engine.rb
@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+module ::MyPluginModule
+  class Engine < ::Rails::Engine
+    engine_name PLUGIN_NAME
+    isolate_namespace MyPluginModule
+    config.autoload_paths << File.join(config.root, "lib")
+    scheduled_job_dir = "#{config.root}/app/jobs/scheduled"
+    config.to_prepare do
+      Rails.autoloaders.main.eager_load_dir(scheduled_job_dir) if Dir.exist?(scheduled_job_dir)
+    end
+  end
+end
diff --git a/package.json b/package.json
@@ -0,0 +1,16 @@
+{
+  "private": true,
+  "devDependencies": {
+    "@discourse/lint-configs": "2.4.0",
+    "ember-template-lint": "6.1.0",
+    "eslint": "9.19.0",
+    "prettier": "2.8.8"
+  },
+  "engines": {
+    "node": ">= 22",
+    "npm": "please-use-pnpm",
+    "yarn": "please-use-pnpm",
+    "pnpm": "9.x"
+  },
+  "packageManager": "pnpm@9.15.5"
+}
diff --git a/plugin.rb b/plugin.rb
@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+# name: discourse-plugin-name
+# about: TODO
+# meta_topic_id: TODO
+# version: 0.0.1
+# authors: Discourse
+# url: TODO
+# required_version: 2.7.0
+
+enabled_site_setting :plugin_name_enabled
+
+module ::MyPluginModule
+  PLUGIN_NAME = "discourse-plugin-name"
+end
+
+require_relative "lib/my_plugin_module/engine"
+
+after_initialize do
+  # Code which should run after Rails has finished booting
+end
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/spec/.gitkeep b/spec/.gitkeep
diff --git a/test/javascripts/.gitkeep b/test/javascripts/.gitkeep

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	`+node_modules`
	`2`	`+/gems`
	`3`	`+/auto_generated`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+engine-strict = true`
	`2`	`+auto-install-peers = false`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1 @@`
	`1`	`+module.exports = require("@discourse/lint-configs/prettier");`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+inherit_gem:`
	`2`	`+ rubocop-discourse: stree-compat.yml`
Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,2 @@`
	`1`	`+--print-width=100`
	`2`	`+--plugins=plugin/trailing_comma,plugin/disable_auto_ternary`