Erstellung von Automatisierungstools für benutzerdefinierte Themes (Gulpjs)

Die Verwendung von Automatisierungstools erleichtert die Erstellung von Themes. Hier verwenden wir gulp js, um ein Automatisierungstool für ein benutzerdefiniertes Theme zu erstellen.

Arbeiten mit Gulp 3.x und Node 10.x und niedriger

Schritte:

1. Node.js installieren
Laden Sie die neueste NodeJS-Version von nodejs.org herunter und installieren Sie sie. Der Installationsprozess kann je nach Betriebssystem variieren.

2. Gulp installieren

npm install gulp-cli -g

3. gulpfile.js einrichten
Wechseln Sie in das Verzeichnis des benutzerdefinierten Themes.

Erstellen Sie die Datei gulpfile.js manuell, entweder über cmd/Terminal oder per Rechtsklick und "Neue Datei erstellen".

touch gulpfile.js

Kopieren Sie den gesamten Code und fügen Sie ihn ein.

Hinweis: Ich habe meine Rohdateien im Ordner 'src' abgelegt, und die fertigen Dateien befinden sich im Root-Ordner des benutzerdefinierten Themes. Daher werden SASS-Dateien aus dem Ordner „my_custom_theme_folder/src/scss“ kompiliert und in den Ordner „my_custom_theme_folder/css“ geschrieben.

var gulp = require('gulp'),
	livereload = require('gulp-livereload'),
	gulpIf = require('gulp-if'),
	eslint = require('gulp-eslint'),
	sass = require('gulp-sass'),
	autoprefixer = require('gulp-autoprefixer'),
	sourcemaps = require('gulp-sourcemaps'),
	imagemin = require('gulp-imagemin'),
	pngquant = require('imagemin-pngquant');
	 
gulp.task('imagemin', function () {
    return gulp.src('./src/images/*')
        .pipe(imagemin({
            progressive: true,
            svgoPlugins: [{removeViewBox: false}],
            use: [pngquant()]
        }))
        .pipe(gulp.dest('./images'));
});


gulp.task('sass', function () {
  gulp.src('./src/sass/**/*.scss')
    .pipe(sourcemaps.init())
        .pipe(sass({outputStyle: 'compressed'}).on('error', sass.logError))
        .pipe(autoprefixer('last 2 version'))
    .pipe(sourcemaps.write('./'))
    .pipe(gulp.dest('./css'));
});

function isFixed(file) {
	// Hat ESLint den Dateiinhalt korrigiert?
	return file.eslint != null && file.eslint.fixed;
}

gulp.task('eslint', function(){
	gulp.src(['./src/js/*.js'])
		.pipe(eslint({
			
  				"extends": "eslint:recommended",
 				"env": {
    				"browser": true
  				},
  				"globals": {
    				"Drupal": true,
    				"drupalSettings": true,
    				"drupalTranslations": true,
    				"domready": true,
    				"jQuery": true,
    				"_": true,
    				"matchMedia": true,
    				"Backbone": true,
    				"Modernizr": true,
    				"CKEDITOR": true
 				 },
 			 "rules": {
    			// Fehler.
    			"array-bracket-spacing": [2, "never"],
    			"block-scoped-var": 2,
   			"brace-style": [2, "stroustrup", {"allowSingleLine": true}],
    			"comma-dangle": [2, "never"],
    			"comma-spacing": 2,
    			"comma-style": [2, "last"],
    			"computed-property-spacing": [2, "never"],
    			"curly": [2, "all"],
    			"eol-last": 2,
    			"eqeqeq": [2, "smart"],
    			"guard-for-in": 2,
    			"indent": [2, 2, {"SwitchCase": 1}],
   			"key-spacing": [2, {"beforeColon": false, "afterColon": true}],
    			"linebreak-style": [2, "unix"],
    			"lines-around-comment": [2, {"beforeBlockComment": true, "afterBlockComment": false}],
    			"new-parens": 2,
    			"no-array-constructor": 2,
    			"no-caller": 2,
    			"no-catch-shadow": 2,
    			"no-empty-label": 2,
    			"no-eval": 2,
    			"no-extend-native": 2,
    			"no-extra-bind": 2,
    			"no-extra-parens": [2, "functions"],
    			"no-implied-eval": 2,
    			"no-iterator": 2,
    			"no-label-var": 2,
    			"no-labels": 2,
    			"no-lone-blocks": 2,
    			"no-loop-func": 2,
    			"no-multi-spaces": 2,
    			"no-multi-str": 2,
    			"no-native-reassign": 2,
    			"no-nested-ternary": 2,
    			"no-new-func": 2,
    			"no-new-object": 2,
   			"no-new-wrappers": 2,
    			"no-octal-escape": 2,
    			"no-process-exit": 2,
    			"no-proto": 2,
    			"no-return-assign": 2,
    			"no-script-url": 2,
    			"no-sequences": 2,
    			"no-shadow-restricted-names": 2,
    			"no-spaced-func": 2,
    			"no-trailing-spaces": 2,
    			"no-undef-init": 2,
    			"no-undefined": 2,
    			"no-unused-expressions": 2,
    			"no-unused-vars": [2, {"vars": "all", "args": "none"}],
   			"no-with": 2,
    			"object-curly-spacing": [2, "never"],
    			"one-var": [2, "never"],
    			"quote-props": [2, "consistent-as-needed"],
    			"semi": [2, "always"],
    			"semi-spacing": [2, {"before": false, "after": true}],
    			"space-after-keywords": [2, "always"],
    			"space-before-blocks": [2, "always"],
    			"space-before-function-paren": [2, {"anonymous": "always", "named": "never"}],
    			"space-in-parens": [2, "never"],
    			"space-infix-ops": 2,
    			"space-return-throw-case": 2,
    			"space-unary-ops": [2, { "words": true, "nonwords": false }],
    			"spaced-comment": [2, "always"],
    			"strict": 2,
    			"yoda": [2, "never"],
    			// Warnungen.
    			"max-nested-callbacks": [1, 3],
    			"valid-jsdoc": [1, {
      			"prefer": {
       		 		"returns": "return",
        				"property": "prop"
      			},
     	 		"requireReturn": false
    			}]
 	 		},
 	 		fix: true,
			
	}))
	.pipe(eslint.format())
	// Wenn korrigiert, schreibe die Datei ins Zielverzeichnis
	.pipe(gulpIf(isFixed, gulp.dest('./js/')));;
});

gulp.task('watch', function(){
    livereload.listen();

    gulp.watch('./src/sass/**/*.scss', ['sass']);
    gulp.watch('./src/js/**/*.js', ['eslint']);
    gulp.watch(['./css/style.css', './**/*.html.twig', './js/*.js'], function (files){
        livereload.changed(files)
    });
});

4. Paketmanager konfigurieren
Geben Sie in Ihrem Terminal im Verzeichnis des benutzerdefinierten Themes den Befehl npm init ein und füllen Sie die angeforderten Informationen aus, um die Datei package.json zu erstellen.

5. Abhängigkeiten installieren
Geben Sie im Terminal im Verzeichnis des benutzerdefinierten Themes den Befehl npm install --save-dev <packagename> ein. Dadurch werden gulp und alle erforderlichen Abhängigkeiten heruntergeladen und der Ordner 'node_modules' erstellt.

6. Automatisierungstool über cmd/Terminal starten.
Jetzt sind Sie bereit, das Automatisierungstool gulp zu starten.
Tippen Sie gulp watch ein.