A platform for community discussion. Free, open, simple.
DEV: Introduce deprecation for `.js.es6` file extension (#38756)
David Tayloreb4cbbe14912
diff --git a/lib/asset_processor.rb b/lib/asset_processor.rbindex 01bc46bae1b..a7b1f49446a 100644--- a/lib/asset_processor.rb+++ b/lib/asset_processor.rb@@ -1,7 +1,7 @@# frozen_string_literal: trueclass AssetProcessor- BASE_COMPILER_VERSION = 103+ BASE_COMPILER_VERSION = 104PROCESSOR_DIR = "tmp/asset-processor"LOCK_FILE = "#{PROCESSOR_DIR}/build.lock"@@ -24,6 +24,21 @@ class AssetProcessor!!@ctxend+ def self.append_es6_deprecation(content, file_path)+ pseudo_random_identifier = "deprecated_gjYVqPLMxe" # Just needs to be unique enough to avoid collisions with real code+ <<~JS+ #{content}+ import #{pseudo_random_identifier} from "discourse/lib/deprecated";+ #{pseudo_random_identifier}(+ "The file '#{file_path}' uses the deprecated `.js.es6` extension. Use `.js` instead.",+ {+ id: "discourse.es6-extension",+ url: "https://meta.discourse.org/t/398894",+ }+ );+ JS+ end+def self.transpile(data, root_path, logical_path, theme_id: nil, extension: nil)processor = new(skip_module: skip_module?(data))processor.perform(data, root_path, logical_path, theme_id: theme_id, extension: extension)diff --git a/lib/plugin/js_manager.rb b/lib/plugin/js_manager.rbindex 7d78d4fde55..c51dfeca2bc 100644--- a/lib/plugin/js_manager.rb+++ b/lib/plugin/js_manager.rb@@ -84,7 +84,11 @@ module Pluginfull_path = File.join(js_base, file)if File.file?(full_path)normalized_file_path = file.sub(/\.js\.es6$/, ".js")- tree[normalized_file_path] = File.read(full_path)+ content = File.read(full_path)+ content = AssetProcessor.append_es6_deprecation(content, file) if file.end_with?(+ ".js.es6",+ )+ tree[normalized_file_path] = contentif name == "test" && file.match(%r{/(acceptance|integration|unit)/})if file.match?(/-test\.g?js$/)entrypoints_config[name][:modules] << normalized_file_pathdiff --git a/lib/theme_javascript_compiler.rb b/lib/theme_javascript_compiler.rbindex 18d119f1899..f9f6a0c1c88 100644--- a/lib/theme_javascript_compiler.rb+++ b/lib/theme_javascript_compiler.rb@@ -26,7 +26,14 @@ class ThemeJavascriptCompilerdef compile!if !@compiled@compiled = true- @input_tree.transform_keys! { |k| k.sub(/\.js\.es6$/, ".js") }+ @input_tree =+ @input_tree.to_h do |k, v|+ if k.end_with?(".js.es6")+ [k.sub(/\.js\.es6$/, ".js"), AssetProcessor.append_es6_deprecation(v, k)]+ else+ [k, v]+ end+ end@input_tree.freezeoutput =diff --git a/spec/lib/theme_javascript_compiler_spec.rb b/spec/lib/theme_javascript_compiler_spec.rbindex c2f52b9acd0..345b1c3ee28 100644--- a/spec/lib/theme_javascript_compiler_spec.rb+++ b/spec/lib/theme_javascript_compiler_spec.rb@@ -243,4 +243,25 @@ RSpec.describe ThemeJavascriptCompiler doexpect(compiler.content).to include("createTemplateFactory")endend++ describe ".js.es6 extension deprecation" do+ it "appends a deprecation warning for .js.es6 files" do+ compiler.append_tree(+ { "discourse/components/my-component.js.es6" => "export default class MyComponent {}" },+ )++ expect(compiler.content).to include("discourse.es6-extension")+ expect(compiler.content).to include(+ "The file 'discourse/components/my-component.js.es6' uses the deprecated `.js.es6` extension. Use `.js` instead.",+ )+ end++ it "does not add deprecation for regular .js files" do+ compiler.append_tree(+ { "discourse/components/my-component.js" => "export default class MyComponent {}" },+ )++ expect(compiler.content).not_to include("discourse.es6-extension")+ end+ endend