Merge pull request #458

Author: AlfredoRamos

.gitattributes

@@ -1,5 +1,4 @@
 * text=auto
-scss/ export-ignore
 tests/ export-ignore
 .github/ export-ignore
 .vscode/ export-ignore
@@ -15,4 +14,3 @@ postcss.config.js export-ignore
 .stylelintrc.json export-ignore
 .tool-versions export-ignore
 *.md export-ignore
-*.scss export-ignore

.github/scripts/build-clean.js

@@ -0,0 +1,29 @@
+'use strict';
+
+import { readFileSync, writeFileSync } from 'fs';
+import { sync } from 'glob';
+import { join } from 'path';
+import { buildPath, unminifiedAssetFile, deleteAssetFile } from './helper.js';
+
+const cssFileList = sync(join(buildPath, 'styles/**/theme/css/*.css')).concat(
+	sync(buildPath + '/adm/style/css/*.css')
+);
+const jsFileList = sync(join(buildPath, 'styles/**/theme/js/*.js')).concat(
+	sync(buildPath + '/adm/style/js/*.js')
+);
+
+cssFileList.forEach((c) => {
+	const file = unminifiedAssetFile(c);
+
+	if (file) {
+		deleteAssetFile(file);
+	}
+});
+
+jsFileList.forEach((j) => {
+	const file = unminifiedAssetFile(j);
+
+	if (file) {
+		deleteAssetFile(file);
+	}
+});

.github/scripts/build-scss.js

@@ -1,6 +1,12 @@
 'use strict';
 
-import { realpathSync, readFileSync, existsSync, mkdirSync } from 'fs';
+import {
+	realpathSync,
+	readFileSync,
+	existsSync,
+	mkdirSync,
+	unlinkSync,
+} from 'fs';
 import { join, extname, basename, dirname } from 'path';
 
 const __filename = new URL(import.meta.url).pathname;
@@ -45,4 +51,32 @@ const replaceAssetFile = (file, html) => {
 	return html;
 };
 
-export { buildPath, replaceAssetFile };
+const unminifiedAssetFile = (file) => {
+	if (!existsSync(file)) {
+		return null;
+	}
+
+	const fileExt = extname(file);
+
+	if (!file.endsWith('.min' + fileExt)) {
+		return null;
+	}
+
+	const unminifiedFile = file.replace('.min' + fileExt, fileExt);
+
+	if (existsSync(unminifiedFile)) {
+		return unminifiedFile;
+	}
+
+	return null;
+};
+
+const deleteAssetFile = (file) => {
+	if (!existsSync(file)) {
+		return;
+	}
+
+	unlinkSync(file);
+};
+
+export { buildPath, replaceAssetFile, unminifiedAssetFile, deleteAssetFile };

.github/scripts/helper.js

@@ -340,6 +340,6 @@ jobs:
         working-directory: extension
         run: npm ci
 
-      - name: Test SCSS
+      - name: Test CSS
         working-directory: extension
-        run: npm run lint-scss
+        run: npm run lint-css

.github/workflows/ci.yml

@@ -1,8 +1,6 @@
 {
-	"extends": "stylelint-config-standard-scss",
 	"plugins": [
-		"stylelint-order",
-		"stylelint-scss"
+		"stylelint-order"
 	],
 	"ignoreFiles": [
 		"**/*.min.css"

.stylelintrc.json

@@ -18,7 +18,6 @@
 	<target name="clean-package">
 		<echo msg="Cleaning files and directories" />
 
-		<delete dir="${dir}/scss" />
 		<delete dir="${dir}/tests" />
 		<delete dir="${dir}/node_modules" />
 		<delete dir="${dir}/.github" />
@@ -99,6 +98,9 @@
 			<fileset dir="${package-directory}/language">
 				<patternset>
 					<include name="**/*.php" />
+					<exclude name="**/en/**/*.php" />
+					<exclude name="**/es/**/*.php" />
+					<exclude name="**/es_x_tu/**/*.php" />
 				</patternset>
 			</fileset>
 		</foreach>
@@ -178,7 +180,10 @@
 
 	<!-- Create the zip and tar ball -->
 	<target name="wrap-package">
-		<echo msg="Creating archives (${vendor-name}/${extension-name} ${version})" />
+		<echo msg="Cleaning build" />
+		<exec command="npm run build-clean" checkreturn="true" />
+
+		<echo msg="Creating archives (${vendor-name}/${extension-name} ${package-version})" />
 		<zip basedir="${build-directory}/package/" destfile="${destination-filename}.zip" />
 		<tar basedir="${build-directory}/package/" destfile="${destination-filename}.tar.gz"
 			compression="gzip" />
@@ -194,4 +199,4 @@
 			</fileset>
 		</manifest>
 	</target>
-</project>
+</project>

build.xml

@@ -97,6 +97,7 @@ static public function getSubscribedEvents()
 	{
 		return [
 			'core.user_setup' => 'load_language',
+			'core.page_header_after' => 'global_template_variables',
 			'core.acp_board_config_edit_add' => 'acp_markdown_configuration',
 			'core.permissions' => 'acp_markdown_permissions',
 			'core.text_formatter_s9e_configure_after' => 'configure_markdown',
@@ -131,6 +132,24 @@ public function load_language($event)
 		$event['lang_set_ext'] = $lang_set_ext;
 	}
 
+	/**
+	 * Set global template variables.
+	 *
+	 * @param object $event
+	 *
+	 * @return void
+	 */
+	public function global_template_variables($event)
+	{
+		$this->template->assign_vars([
+			'MARKDOWN_CREDIT_LINE' => $this->language->lang(
+				'CREDIT_LINE',
+				$this->helper::EXTENSION_URL,
+				$this->helper::VENDOR_URL,
+			)
+		]);
+	}
+
 	/**
 	 * Add markdown configuration in ACP.
 	 *

event/listener.php

@@ -17,6 +17,12 @@ class helper
 	/** @var string */
 	protected $php_ext;
 
+	/** @var string */
+	public const VENDOR_URL = 'https://alfredoramos.mx';
+
+	/** @var string */
+	public const EXTENSION_URL = 'https://www.phpbb.com/customise/db/extension/markdown/';
+
 	/**
 	 * Helper constructor.
 	 *

includes/helper.php

@@ -27,5 +27,6 @@
 	'MARKDOWN_STATUS_FORMAT' => '<a href="%1$s">Markdown</a> is <em>%2$s</em>',
 	'MARKDOWN_IS_ON' => 'ON',
 	'MARKDOWN_IS_OFF' => 'OFF',
-	'DISABLE_MARKDOWN' => 'Disable Markdown'
+	'DISABLE_MARKDOWN' => 'Disable Markdown',
+	'CREDIT_LINE' => '<a href="%1$s" rel="external noreferrer noopener" target="_blank">Markdown</a> extension © <a href="%2$s" rel="external noreferrer noopener" target="_blank">Alfredo Ramos</a>'
 ]);