Skip to content

Commit 5cfa8b0

Browse files
alexslavralexslavr
authored
Move devextreme-dist to packages and add documentation files (#33240)
1 parent 2f5e43c commit 5cfa8b0

File tree

8 files changed

+56
-10
lines changed

8 files changed

+56
-10
lines changed

‎packages/devextreme-dist/LICENSE.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
## Licensing
2+
3+
Consult the [DevExtreme Licensing Page](https://js.devexpress.com/Licensing/) for licensing terms.

‎packages/devextreme-dist/README.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# DevExtreme Bundles
2+
3+
Contains ready-to-use bundles designed to integrate DevExtreme JavaScript components into jQuery applications (can also be used with frameworks that DevExtreme does not support out of the box).
4+
5+
Visit [js.devexpress.com](https://js.devexpress.com/) to learn more about DevExtreme JavaScript UI components and supported development frameworks.
6+
7+
## Installation and Usage
8+
9+
Install the package and reference DevExtreme scripts and stylesheets within the `<head>` tag of your application's index page. For additional information, refer to the following guides:
10+
11+
- [DevExtreme jQuery/JS - Distribution Channels](https://js.devexpress.com/jQuery/Documentation/Guide/Common/Distribution_Channels/#npm)
12+
- [DevExtreme jQuery/JS - Add DevExtreme to a jQuery Application](https://js.devexpress.com/jQuery/Documentation/Guide/jQuery_Components/Add_DevExtreme_to_a_jQuery_Application/)
13+
14+
## License
15+
16+
See [DevExtreme Licensing](https://js.devexpress.com/Licensing/).
17+
18+
## Support
19+
20+
For technical support, visit the [DevExpress Support Center](https://www.devexpress.com/sc).

packages/devextreme/artifacts/npm/devextreme-dist/package.json renamed to packages/devextreme-dist/package.json

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -42,13 +42,18 @@
4242
"Responsive-ui",
4343
"Javascript",
4444
"Typescript",
45-
"shadowdom"
45+
"shadowdom"
4646
],
4747
"homepage": "https://js.devexpress.com/",
4848
"bugs": "https://www.devexpress.com/support/",
49+
"license": "SEE LICENSE IN LICENSE.md",
4950
"author": "Developer Express Inc.",
5051
"repository": {
5152
"type": "git",
5253
"url": "https://github.com/DevExpress/DevExtreme.git"
54+
},
55+
"publishConfig": {
56+
"directory": "../devextreme/artifacts/npm/devextreme-dist",
57+
"linkDirectory": true
5358
}
5459
}

‎packages/devextreme/.gitignore‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
node_modules
22
/artifacts
3-
!/artifacts/npm/devextreme-dist/package.json
43
/testing/testcafe/artifacts
54
/testing/LastSuiteTime.txt
65
/dotnet_packages

‎packages/devextreme/build/gulp/npm.js‎

Lines changed: 24 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,10 @@ const ctx = require('./context.js');
1717
const env = require('./env-variables.js');
1818
const dataUri = require('./gulp-data-uri').gulpPipe;
1919
const headerPipes = require('./header-pipes.js');
20-
const { packageDir, packageDistDir, isEsmPackage, stringSrc, devextremeDistDir } = require('./utils');
20+
const { packageDir, packageDistDir, isEsmPackage, stringSrc } = require('./utils');
2121

2222
const resultPath = ctx.RESULT_NPM_PATH;
23+
const devextremeDistWorkspacePackageJsonPath = '../devextreme-dist/package.json';
2324

2425
const srcGlobsPattern = (path, exclude) => [
2526
`${path}/**/*.js`,
@@ -158,9 +159,28 @@ const distPath = `${resultPath}/${packageDistDir}`;
158159
gulp.task('npm-sources', gulp.series(
159160
'ts-sources',
160161
() => gulp
161-
.src(`${resultPath}/${devextremeDistDir}/package.json`)
162-
.pipe(overwriteInternalPackageName())
163-
.pipe(gulpIf(env.BUILD_INTERNAL_PACKAGE, gulp.dest(distPath))),
162+
.src(devextremeDistWorkspacePackageJsonPath)
163+
.pipe(
164+
through.obj((file, enc, callback) => {
165+
const pkg = JSON.parse(file.contents.toString(enc));
166+
167+
pkg.version = ctx.version;
168+
delete pkg.publishConfig;
169+
170+
file.contents = Buffer.from(JSON.stringify(pkg, null, 2));
171+
callback(null, file);
172+
})
173+
)
174+
.pipe(gulpIf(env.BUILD_INTERNAL_PACKAGE, overwriteInternalPackageName()))
175+
.pipe(gulp.dest(distPath)),
176+
() => merge(
177+
gulp
178+
.src('../devextreme-dist/README.md')
179+
.pipe(gulp.dest(distPath)),
180+
gulp
181+
.src('../devextreme-dist/LICENSE.md')
182+
.pipe(gulp.dest(distPath)),
183+
),
164184
sources(srcGlobs, packagePath, distGlobs))
165185
);
166186

‎packages/devextreme/gulpfile.js‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,6 @@ gulp.task('clean', function(callback) {
2222
'!artifacts/npm/devextreme',
2323
'!artifacts/npm/devextreme/*.json',
2424
'!artifacts/npm/devextreme-dist',
25-
'!artifacts/npm/devextreme-dist/*.json',
2625
]);
2726
cache.clearAll();
2827
callback();

‎pnpm-lock.yaml‎

Lines changed: 3 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

‎pnpm-workspace.yaml‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,6 @@ packages:
22
- 'apps/*'
33
- 'e2e/*'
44
- 'packages/*'
5-
- 'packages/devextreme/artifacts/npm/devextreme-dist'
65
- '!packages/sbom'
76

87
catalog:

0 commit comments

Comments
 (0)