aboutsummaryrefslogtreecommitdiffstats
path: root/share/qbs/modules/nodejs/NodeJS.qbs
blob: 7fd992fdb21132f9d207867515b78a9bdfa6256d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
/****************************************************************************
**
** Copyright (C) 2015 The Qt Company Ltd.
** Contact: http://www.qt.io/licensing
**
** This file is part of Qbs.
**
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms and
** conditions see http://www.qt.io/terms-conditions. For further information
** use the contact form at http://www.qt.io/contact-us.
**
** GNU Lesser General Public License Usage
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 or version 3 as published by the Free
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
** LICENSE.LGPLv3 included in the packaging of this file.  Please review the
** following information to ensure the GNU Lesser General Public License
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** In addition, as a special exception, The Qt Company gives you certain additional
** rights.  These rights are described in The Qt Company LGPL Exception
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
**
****************************************************************************/

import qbs.Environment
import qbs.File
import qbs.FileInfo
import qbs.ModUtils
import qbs.Probes

Module {
    // JavaScript files which have been "processed" - currently this simply means "copied to output
    // directory" but might later include minification and obfuscation processing
    additionalProductTypes: ["nodejs_processed_js"].concat(applicationFile ? ["application"] : [])

    Probes.NodeJsProbe {
        id: nodejs
        searchPaths: toolchainInstallPath ? [toolchainInstallPath] : []
    }

    Probes.NpmProbe {
        id: npm
        searchPaths: toolchainInstallPath ? [toolchainInstallPath] : []
        interpreterPath: FileInfo.path(nodejs.filePath)
    }

    property path applicationFile
    PropertyOptions {
        name: "applicationFile"
        description: "file whose corresponding output will be executed when running the Node.js app"
    }

    Group {
        name: "Application file";
        prefix: product.sourceDirectory + '/'
        files: nodejs.applicationFile ? [nodejs.applicationFile] : []
    }

    property path toolchainInstallPath: {
        if (nodejs.path && npm.path && nodejs.path !== npm.path)
            throw("node and npm binaries do not belong to the same installation ("
                  + nodejs.path + " vs " + npm.path + ")");
        return nodejs.path || npm.path;
    }

    property path interpreterFileName: nodejs.fileName
    property path interpreterFilePath: nodejs.filePath

    property path packageManagerFileName: npm.fileName
    property path packageManagerFilePath: npm.filePath

    property path packageManagerBinPath: npm.npmBin
    property path packageManagerRootPath: npm.npmRoot
    property path packageManagerPrefixPath: npm.npmPrefix

    // private properties
    readonly property path compiledIntermediateDir: FileInfo.joinPaths(product.buildDirectory,
                                                                       "tmp", "nodejs.intermediate")

    setupBuildEnvironment: {
        var v = new ModUtils.EnvironmentVariable("PATH", product.qbs.pathListSeparator, product.qbs.hostOS.contains("windows"));
        v.prepend(product.nodejs.toolchainInstallPath);
        v.set();
    }

    setupRunEnvironment: {
        var v = new ModUtils.EnvironmentVariable("NODE_PATH", product.qbs.pathListSeparator, product.qbs.hostOS.contains("windows"));
        v.prepend(FileInfo.path(Environment.getEnv("QBS_RUN_FILE_PATH")));
        v.set();
    }

    FileTagger {
        patterns: ["*.js"]
        fileTags: ["js"]
    }

    validate: {
        var validator = new ModUtils.PropertyValidator("nodejs");
        validator.setRequiredProperty("toolchainInstallPath", toolchainInstallPath);
        validator.setRequiredProperty("interpreterFileName", interpreterFileName);
        validator.setRequiredProperty("interpreterFilePath", interpreterFilePath);
        validator.setRequiredProperty("packageManagerFileName", packageManagerFileName);
        validator.setRequiredProperty("packageManagerFilePath", packageManagerFilePath);
        validator.setRequiredProperty("packageManagerBinPath", packageManagerBinPath);
        validator.setRequiredProperty("packageManagerRootPath", packageManagerRootPath);
        validator.setRequiredProperty("packageManagerPrefixPath", packageManagerPrefixPath);
        validator.validate();
    }

    Rule {
        inputs: ["js"]

        outputArtifacts: {
            var tags = ["nodejs_processed_js"];
            if (input.fileTags.contains("application_js") ||
                product.moduleProperty("nodejs", "applicationFile") === input.filePath)
                tags.push("application");

            // Preserve directory structure of input files
            var intermediatePath = product.sourceDirectory;

            // Handle nodejs.compiledIntermediateDir (QBS-5 workaround)
            var compiled = product.moduleProperty("nodejs", "compiledIntermediateDir");
            if (input.filePath.startsWith(compiled)) {
                intermediatePath = compiled;
            }

            intermediatePath = FileInfo.path(FileInfo.relativePath(intermediatePath,
                                                                   input.filePath));

            return [{
                filePath: FileInfo.joinPaths(product.destinationDirectory, intermediatePath,
                                             input.fileName),
                fileTags: tags
            }];
        }

        outputFileTags: ["nodejs_processed_js", "application"]

        prepare: {
            var cmd = new JavaScriptCommand();
            cmd.description = "copying " + input.fileName;
            cmd.sourceCode = function() {
                File.copy(input.filePath, output.filePath);
            };
            return cmd;
        }
    }
}