angular/aio/tools/transforms/angular-base-package/services/getImageDimensions.js

const { join } = require('canonical-path');
const sizeOf = require('image-size');

module.exports = function getImageDimensions() {
  return (basePath, path) => sizeOf(join(basePath, path));
};
build(docs-infra): be able to resolve root-relative image URLs in `getImageDimensions()` (#46138) Previously, `getImageDimensions()` would try to resolve image URLs relative to the base path using `path.resolve()`. This resulted in root-relative URLs (i.e. URLs starting with `/`) being treated as absolute filesystem paths and thus resolving incorrectly ([example failure][1]). This commit fixes it by using `.join()` instead, which is more appropriate in this case. (Originally discussed [here][2].) [1]: https://circleci.com/gh/angular/angular/1173150 [2]: https://github.com/angular/angular/pull/46134#issuecomment-1137191996 PR Close #46138 2022-05-25 18:32:53 +00:00			`const { join } = require('canonical-path');`
build(aio): auto-fill width/height to all image tags Parse all `<img>` tags, during doc-gen, and insert the width and height of the sourceed image, if neither are already specified. Warnings are reported if the `<img>` tag has no `src` attribute or the image cannot be loaded. The work is done in the `addImageDimensions` post-processor, which must be configured with a `basePath` so that it knows where to find the images. Closes #15888 2017-04-28 14:05:05 +00:00			`const sizeOf = require('image-size');`

			`module.exports = function getImageDimensions() {`
build(docs-infra): be able to resolve root-relative image URLs in `getImageDimensions()` (#46138) Previously, `getImageDimensions()` would try to resolve image URLs relative to the base path using `path.resolve()`. This resulted in root-relative URLs (i.e. URLs starting with `/`) being treated as absolute filesystem paths and thus resolving incorrectly ([example failure][1]). This commit fixes it by using `.join()` instead, which is more appropriate in this case. (Originally discussed [here][2].) [1]: https://circleci.com/gh/angular/angular/1173150 [2]: https://github.com/angular/angular/pull/46134#issuecomment-1137191996 PR Close #46138 2022-05-25 18:32:53 +00:00			`return (basePath, path) => sizeOf(join(basePath, path));`
build(aio): auto-fill width/height to all image tags Parse all `<img>` tags, during doc-gen, and insert the width and height of the sourceed image, if neither are already specified. Warnings are reported if the `<img>` tag has no `src` attribute or the image cannot be loaded. The work is done in the `addImageDimensions` post-processor, which must be configured with a `basePath` so that it knows where to find the images. Closes #15888 2017-04-28 14:05:05 +00:00			`};`