cordova-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From jasongin <>
Subject [GitHub] cordova-lib pull request: CB-11117: Add FileUpdater module to cord...
Date Sat, 30 Apr 2016 05:36:33 GMT
Github user jasongin commented on a diff in the pull request:
    --- Diff: cordova-common/src/FileUpdater.js ---
    @@ -0,0 +1,499 @@
    +    Licensed to the Apache Software Foundation (ASF) under one
    +    or more contributor license agreements.  See the NOTICE file
    +    distributed with this work for additional information
    +    regarding copyright ownership.  The ASF licenses this file
    +    to you under the Apache License, Version 2.0 (the
    +    "License"); you may not use this file except in compliance
    +    with the License.  You may obtain a copy of the License at
    +    Unless required by applicable law or agreed to in writing,
    +    software distributed under the License is distributed on an
    +    KIND, either express or implied.  See the License for the
    +    specific language governing permissions and limitations
    +    under the License.
    +"use strict";
    +var fs = require("fs");
    +var path = require("path");
    +var shell = require("shelljs");
    +var minimatch = require("minimatch");
    +var isWindows = (process.platform === "win32");
    +var child_process = (isWindows ? require("child_process") : null);
    + * Logging callback used in the FileUpdater methods.
    + * @callback loggingCallback
    + * @param {string} message A message describing a single file update operation.
    + */
    + * Updates a target file or directory with a source file or directory. (Directory updates
    + * not recursive.) Stats for target and source items must be passed in. This is an internal
    + * helper function used by other methods in this module.
    + *
    + * @param {?string} sourcePath Source file or directory to be used to update the
    + *     destination. If the source is null, then the destination is deleted if it exists.
    + * @param {?fs.Stats} sourceStats An instance of fs.Stats for the source path, or null
    + *     the source does not exist.
    + * @param {string} targetPath Required destination file or directory to be updated. If
it does
    + *     not exist, it will be created.
    + * @param {?fs.Stats} targetStats An instance of fs.Stats for the target path, or null
    + *     the target does not exist.
    + * @param {Object} [options] Optional additional parameters for the update.
    + * @param {string} [options.rootDir] Optional root directory (such as a project) to which
    + *     and source path parameters are relative; may be omitted if the paths are absolute.
    + *     rootDir is always omitted from any logged paths, to make the logs easier to read.
    + * @param {boolean} [options.all] If true, all files are copied regardless of last-modified
    + * @param {boolean} [options.newer] If true (and all is not specified), only files with
    + *     last-modified times are copied. By default, only files with different times are
    + * @param {loggingCallback} [log] Optional logging callback that takes a string message
    + *     describing any file operations that are performed.
    + * @param {Object} context Context object for tracking file operations.
    + * @return {boolean} true if any changes were made, or false if the force flag is not
    + *     and everything was up to date
    + */
    +function updatePathWithStats(
    +        sourcePath, sourceStats, targetPath, targetStats, options, log, context) {
    +    var updated = false;
    +    var rootDir = (options && options.rootDir) || "";
    +    var copyAll = (options && options.all) || false;
    +    var copyNewer = (options && options.newer) || false;
    +    var targetFullPath = path.join(rootDir || "", targetPath);
    +    if (sourceStats) {
    +        var sourceFullPath = path.join(rootDir || "", sourcePath);
    +        if (targetStats) {
    +            // The target exists. But if the directory status doesn't match the source,
delete it.
    +            if (targetStats.isDirectory() && !sourceStats.isDirectory()) {
    +                log("rmdir  " + targetPath + " (source is a file)");
    --- End diff --
    Yes. Basically I wanted to enable callers to choose whether they want any logging and
what level and format. I expect these functions could be useful in more than one scenario,
so logging requirements may be different.
    Initially I am passing in events.emit.bind('verbose') as the logging callback to these
functions in the updates I'm making to each platform's prepare code. But I know we may want
to adjust logging levels and styles soon in the platform code, and it will be easier to do
that if we don't have to update cordova-common also.

If your project is set up for it, you can reply to this email and have your
reply appear on GitHub as well. If your project does not have this feature
enabled and wishes so, or if the feature is enabled but not working, please
contact infrastructure at or file a JIRA ticket
with INFRA.

To unsubscribe, e-mail:
For additional commands, e-mail:

View raw message