index.js 854 B

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. /**
  2. * @typedef {import('unist').Node} Node
  3. */
  4. /**
  5. * @typedef Options
  6. * Configuration.
  7. * @property {boolean | null | undefined} [force=false]
  8. * Whether to use `delete` to remove `position` fields.
  9. *
  10. * The default is to set them to `undefined`.
  11. */
  12. import {visit} from 'unist-util-visit'
  13. /**
  14. * Remove the `position` field from a tree.
  15. *
  16. * @param {Node} tree
  17. * Tree to clean.
  18. * @param {Options | null | undefined} [options={force: false}]
  19. * Configuration (default: `{force: false}`).
  20. * @returns {undefined}
  21. * Nothing.
  22. */
  23. export function removePosition(tree, options) {
  24. const config = options || {}
  25. const force = config.force || false
  26. visit(tree, remove)
  27. /**
  28. * @param {Node} node
  29. */
  30. function remove(node) {
  31. if (force) {
  32. delete node.position
  33. } else {
  34. node.position = undefined
  35. }
  36. }
  37. }