summaryrefslogtreecommitdiff
path: root/buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php
diff options
context:
space:
mode:
Diffstat (limited to 'buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php')
-rw-r--r--buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php284
1 files changed, 284 insertions, 0 deletions
diff --git a/buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php b/buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php
new file mode 100644
index 00000000..77a4aad5
--- /dev/null
+++ b/buildscripts/phing/classes/phing/tasks/ext/JslLintTask.php
@@ -0,0 +1,284 @@
+<?php
+/*
+ * $Id: 551de2e94aa21f44e19dd0806051f1eabf8b20f9 $
+ *
+ * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
+ * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
+ * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
+ * A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
+ * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+ * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
+ * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+ * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+ * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+ * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+ *
+ * This software consists of voluntary contributions made by many individuals
+ * and is licensed under the LGPL. For more information please see
+ * <http://phing.info>.
+ */
+
+require_once 'phing/Task.php';
+require_once 'phing/util/DataStore.php';
+
+/**
+ * A Javascript lint task. Checks syntax of Javascript files.
+ * Javascript lint (http://www.javascriptlint.com) must be in the system path.
+ * This class is based on Knut Urdalen's PhpLintTask.
+ *
+ * @author Stefan Priebsch <stefan.priebsch@e-novative.de>
+ * @version $Id: 551de2e94aa21f44e19dd0806051f1eabf8b20f9 $
+ * @package phing.tasks.ext
+ */
+class JslLintTask extends Task
+{
+ protected $file; // the source file (from xml attribute)
+ protected $filesets = array(); // all fileset objects assigned to this task
+
+ protected $showWarnings = true;
+ protected $haltOnFailure = false;
+ protected $hasErrors = false;
+ private $badFiles = array();
+
+ private $cache = null;
+ private $conf = null;
+
+ private $executable = "jsl";
+
+ /**
+ * @var PhingFile
+ */
+ protected $tofile = null;
+
+ /**
+ * Sets the flag if warnings should be shown
+ * @param boolean $show
+ */
+ public function setShowWarnings($show) {
+ $this->showWarnings = StringHelper::booleanValue($show);
+ }
+
+ /**
+ * The haltonfailure property
+ * @param boolean $aValue
+ */
+ public function setHaltOnFailure($aValue) {
+ $this->haltOnFailure = $aValue;
+ }
+
+ /**
+ * File to be performed syntax check on
+ * @param PhingFile $file
+ */
+ public function setFile(PhingFile $file) {
+ $this->file = $file;
+ }
+
+ /**
+ * Whether to store last-modified times in cache
+ *
+ * @param PhingFile $file
+ */
+ public function setCacheFile(PhingFile $file)
+ {
+ $this->cache = new DataStore($file);
+ }
+
+ /**
+ * jsl config file
+ *
+ * @param PhingFile $file
+ */
+ public function setConfFile(PhingFile $file)
+ {
+ $this->conf = $file;
+ }
+
+ public function setExecutable($path){
+ $this->executable = $path;
+
+ if (!@file_exists($path)) {
+ throw new BuildException("JavaScript Lint executable '{$path}' not found");
+ }
+ }
+
+ public function getExecutable(){
+ return $this->executable;
+ }
+
+ /**
+ * Nested creator, creates a FileSet for this task
+ *
+ * @return FileSet The created fileset object
+ */
+ public function createFileSet() {
+ $num = array_push($this->filesets, new FileSet());
+ return $this->filesets[$num-1];
+ }
+
+ /**
+ * File to save error messages to
+ *
+ * @param PhingFile $file
+ */
+ public function setToFile(PhingFile $tofile)
+ {
+ $this->tofile = $tofile;
+ }
+
+ /**
+ * Execute lint check against PhingFile or a FileSet
+ */
+ public function main() {
+ if(!isset($this->file) and count($this->filesets) == 0) {
+ throw new BuildException("Missing either a nested fileset or attribute 'file' set");
+ }
+
+ if (empty($this->executable)) {
+ throw new BuildException("Missing the 'executable' attribute");
+ }
+
+ if($this->file instanceof PhingFile) {
+ $this->lint($this->file->getPath());
+ } else { // process filesets
+ $project = $this->getProject();
+ foreach($this->filesets as $fs) {
+ $ds = $fs->getDirectoryScanner($project);
+ $files = $ds->getIncludedFiles();
+ $dir = $fs->getDir($this->project)->getPath();
+ foreach($files as $file) {
+ $this->lint($dir.DIRECTORY_SEPARATOR.$file);
+ }
+ }
+ }
+
+ // write list of 'bad files' to file (if specified)
+ if ($this->tofile) {
+ $writer = new FileWriter($this->tofile);
+
+ foreach ($this->badFiles as $file => $messages) {
+ foreach ($messages as $msg) {
+ $writer->write($file . "=" . $msg . PHP_EOL);
+ }
+ }
+
+ $writer->close();
+ }
+
+ if ($this->haltOnFailure && $this->hasErrors) throw new BuildException('Syntax error(s) in JS files:' .implode(', ', array_keys($this->badFiles)));
+ }
+
+ /**
+ * Performs the actual syntax check
+ *
+ * @param string $file
+ * @return void
+ */
+ protected function lint($file)
+ {
+ $command = $this->executable . ' -output-format ' . escapeshellarg('file:__FILE__;line:__LINE__;message:__ERROR__') . ' ';
+
+ if (isset($this->conf)) {
+ $command .= '-conf ' . escapeshellarg($this->conf->getPath()) . ' ';
+ }
+
+ $command .= '-process ';
+
+ if(file_exists($file))
+ {
+ if(is_readable($file))
+ {
+ if ($this->cache)
+ {
+ $lastmtime = $this->cache->get($file);
+
+ if ($lastmtime >= filemtime($file))
+ {
+ $this->log("Not linting '" . $file . "' due to cache", Project::MSG_DEBUG);
+ return false;
+ }
+ }
+
+ $messages = array();
+ exec($command.'"'.$file.'"', $messages, $return);
+
+ if ($return > 100) {
+ throw new BuildException("Could not execute Javascript Lint executable '{$this->executable}'");
+ }
+
+ $summary = $messages[sizeof($messages) - 1];
+
+ preg_match('/(\d+)\serror/', $summary, $matches);
+ $errorCount = (count($matches) > 1 ? $matches[1] : 0);
+
+ preg_match('/(\d+)\swarning/', $summary, $matches);
+ $warningCount = (count($matches) > 1 ? $matches[1] : 0);
+
+ $errors = array();
+ $warnings = array();
+ if ($errorCount > 0 || $warningCount > 0) {
+ $last = false;
+ foreach ($messages as $message) {
+ $matches = array();
+ if (preg_match('/^(\.*)\^$/', $message)) {
+ $column = strlen($message);
+ if ($last == 'error') {
+ $errors[count($errors) - 1]['column'] = $column;
+ } else if ($last == 'warning') {
+ $warnings[count($warnings) - 1]['column'] = $column;
+ }
+ $last = false;
+ }
+ if (!preg_match('/^file:(.+);line:(\d+);message:(.+)$/', $message, $matches)) continue;
+ $msg = $matches[3];
+ $data = array('filename' => $matches[1], 'line' => $matches[2], 'message' => $msg);
+ if (preg_match('/^.*error:.+$/i', $msg)) {
+ $errors[] = $data;
+ $last = 'error';
+ } else if (preg_match('/^.*warning:.+$/i', $msg)) {
+ $warnings[] = $data;
+ $last = 'warning';
+ }
+ }
+ }
+
+ if($this->showWarnings && $warningCount > 0)
+ {
+ $this->log($file . ': ' . $warningCount . ' warnings detected', Project::MSG_WARN);
+ foreach ($warnings as $warning) {
+ $this->log('- line ' . $warning['line'] . (isset($warning['column']) ? ' column ' . $warning['column'] : '') . ': ' . $warning['message'], Project::MSG_WARN);
+ }
+ }
+
+ if($errorCount > 0)
+ {
+ $this->log($file . ': ' . $errorCount . ' errors detected', Project::MSG_ERR);
+ if (!isset($this->badFiles[$file])) {
+ $this->badFiles[$file] = array();
+ }
+
+ foreach ($errors as $error) {
+ $message = 'line ' . $error['line'] . (isset($error['column']) ? ' column ' . $error['column'] : '') . ': ' . $error['message'];
+ $this->log('- ' . $message, Project::MSG_ERR);
+ array_push($this->badFiles[$file], $message);
+ }
+ $this->hasErrors = true;
+ } else if (!$this->showWarnings || $warningCount == 0) {
+ $this->log($file . ': No syntax errors detected', Project::MSG_VERBOSE);
+
+ if ($this->cache)
+ {
+ $this->cache->put($file, filemtime($file));
+ }
+ }
+ } else {
+ throw new BuildException('Permission denied: '.$file);
+ }
+ } else {
+ throw new BuildException('File not found: '.$file);
+ }
+ }
+}
+
+
generated by cgit v1.2.3 (git 2.39.1) at 2024-07-05 13:26:13 +0000