@atlaskit/code 15.3.1 → 15.4.0

package/CHANGELOG.md

@@ -1,5 +1,14 @@
 # @atlaskit/code
 
+## 15.4.0
+
+### Minor Changes
+
+- [#116950](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/116950)
+  [`c3908db22d486`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/c3908db22d486) -
+  CodeBlock supports a new `firstLineNumber` prop, which allows the starting line number to be set
+  (defaulting to 1).
+
 ## 15.3.1
 
 ### Patch Changes

package/dist/cjs/code-block.js

@@ -30,6 +30,8 @@ var _syntaxHighlighter = _interopRequireDefault(require("./syntax-highlighter"))
 var CodeBlock = /*#__PURE__*/(0, _react.memo)(function CodeBlock(_ref) {
   var _ref$showLineNumbers = _ref.showLineNumbers,
     showLineNumbers = _ref$showLineNumbers === void 0 ? true : _ref$showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber,
     _ref$language = _ref.language,
     providedLanguage = _ref$language === void 0 ? 'text' : _ref$language,
     _ref$highlight = _ref.highlight,
@@ -47,7 +49,7 @@ var CodeBlock = /*#__PURE__*/(0, _react.memo)(function CodeBlock(_ref) {
     codeBidiWarningTooltipEnabled = _ref$codeBidiWarningT === void 0 ? true : _ref$codeBidiWarningT,
     _ref$shouldWrapLongLi = _ref.shouldWrapLongLines,
     shouldWrapLongLines = _ref$shouldWrapLongLi === void 0 ? false : _ref$shouldWrapLongLi;
-  var numLines = (text || '').split('\n').length;
+  var numLines = (text || '').split('\n').length + (firstLineNumber > 0 ? firstLineNumber : 1) - 1;
   var theme = (0, _react.useMemo)(function () {
     return (0, _styles.getCodeBlockTheme)(numLines);
   }, [numLines]);
@@ -81,6 +83,7 @@ var CodeBlock = /*#__PURE__*/(0, _react.memo)(function CodeBlock(_ref) {
     language: languageToUse,
     css: styles,
     showLineNumbers: showLineNumbers,
+    firstLineNumber: firstLineNumber,
     lineProps: getLineProps
     // shouldCreateParentElementForLines is needed to pass down props to each line.
     // This is necessary for both line highlighting and testId's, as each of

package/dist/cjs/syntax-highlighter/lib/highlight.js

@@ -10,7 +10,7 @@ var _objectWithoutProperties2 = _interopRequireDefault(require("@babel/runtime/h
 var _react = require("react");
 var _process = _interopRequireDefault(require("./process"));
 var _reactRenderer = _interopRequireDefault(require("./react-renderer"));
-var _excluded = ["language", "testId", "text", "codeTagProps", "showLineNumbers", "shouldCreateParentElementForLines", "shouldWrapLongLines", "lineProps", "codeBidiWarnings", "codeBidiWarningLabel", "codeBidiWarningTooltipEnabled", "astGenerator"];
+var _excluded = ["language", "testId", "text", "codeTagProps", "showLineNumbers", "firstLineNumber", "shouldCreateParentElementForLines", "shouldWrapLongLines", "lineProps", "codeBidiWarnings", "codeBidiWarningLabel", "codeBidiWarningTooltipEnabled", "astGenerator"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 /**
@@ -33,6 +33,8 @@ var Highlight = /*#__PURE__*/(0, _react.memo)(function Highlight(_ref) {
     } : _ref$codeTagProps,
     _ref$showLineNumbers = _ref.showLineNumbers,
     showLineNumbers = _ref$showLineNumbers === void 0 ? false : _ref$showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber,
     _ref$shouldCreatePare = _ref.shouldCreateParentElementForLines,
     shouldCreateParentElementForLines = _ref$shouldCreatePare === void 0 ? false : _ref$shouldCreatePare,
     _ref$shouldWrapLongLi = _ref.shouldWrapLongLines,
@@ -76,7 +78,8 @@ var Highlight = /*#__PURE__*/(0, _react.memo)(function Highlight(_ref) {
     language: language,
     shouldCreateParentElementForLines: shouldCreateParentElementForLines || !!shouldWrapLongLines,
     lineProps: lineProps,
-    showLineNumbers: showLineNumbers
+    showLineNumbers: showLineNumbers,
+    firstLineNumber: firstLineNumber
   });
 
   // Rows + logic into a renderer

package/dist/cjs/syntax-highlighter/lib/process/index.js

@@ -25,9 +25,11 @@ function processLines(_ref) {
     language = _ref.language,
     shouldCreateParentElementForLines = _ref.shouldCreateParentElementForLines,
     lineProps = _ref.lineProps,
-    showLineNumbers = _ref.showLineNumbers;
+    showLineNumbers = _ref.showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber;
   var codeTree = (0, _getCodeTree.default)(language, code, astGenerator);
-  var startingLineNumber = 1;
+  var startingLineNumber = firstLineNumber > 0 ? firstLineNumber : 1;
   var createLine = (0, _createLine.default)(lineProps, shouldCreateParentElementForLines, showLineNumbers);
   var newTree = [];
   var lastLineBreakIndex = -1;

package/dist/es2019/code-block.js

@@ -22,6 +22,7 @@ import SyntaxHighlighter from './syntax-highlighter';
  */
 const CodeBlock = /*#__PURE__*/memo(function CodeBlock({
   showLineNumbers = true,
+  firstLineNumber = 1,
   language: providedLanguage = 'text',
   highlight = '',
   highlightedStartText = 'Highlight start',
@@ -33,7 +34,7 @@ const CodeBlock = /*#__PURE__*/memo(function CodeBlock({
   codeBidiWarningTooltipEnabled = true,
   shouldWrapLongLines = false
 }) {
-  const numLines = (text || '').split('\n').length;
+  const numLines = (text || '').split('\n').length + (firstLineNumber > 0 ? firstLineNumber : 1) - 1;
   const theme = useMemo(() => getCodeBlockTheme(numLines), [numLines]);
   const getStyles = useMemo(() => getCodeBlockStyles(theme), [theme]);
   const styles = useMemo(() => css(
@@ -58,6 +59,7 @@ const CodeBlock = /*#__PURE__*/memo(function CodeBlock({
     language: languageToUse,
     css: styles,
     showLineNumbers: showLineNumbers,
+    firstLineNumber: firstLineNumber,
     lineProps: getLineProps
     // shouldCreateParentElementForLines is needed to pass down props to each line.
     // This is necessary for both line highlighting and testId's, as each of

package/dist/es2019/syntax-highlighter/lib/highlight.js

@@ -18,6 +18,7 @@ const Highlight = /*#__PURE__*/memo(function Highlight({
     className: `language-${language}`
   },
   showLineNumbers = false,
+  firstLineNumber = 1,
   shouldCreateParentElementForLines = false,
   shouldWrapLongLines = false,
   lineProps = {},
@@ -59,7 +60,8 @@ const Highlight = /*#__PURE__*/memo(function Highlight({
     language,
     shouldCreateParentElementForLines: shouldCreateParentElementForLines || !!shouldWrapLongLines,
     lineProps,
-    showLineNumbers
+    showLineNumbers,
+    firstLineNumber
   });
 
   // Rows + logic into a renderer

package/dist/es2019/syntax-highlighter/lib/process/index.js

@@ -18,10 +18,11 @@ export default function processLines({
   language,
   shouldCreateParentElementForLines,
   lineProps,
-  showLineNumbers
+  showLineNumbers,
+  firstLineNumber = 1
 }) {
   const codeTree = getCodeTree(language, code, astGenerator);
-  const startingLineNumber = 1;
+  const startingLineNumber = firstLineNumber > 0 ? firstLineNumber : 1;
   const createLine = createLineGenerator(lineProps, shouldCreateParentElementForLines, showLineNumbers);
   const newTree = [];
   let lastLineBreakIndex = -1;

package/dist/esm/code-block.js

@@ -23,6 +23,8 @@ import SyntaxHighlighter from './syntax-highlighter';
 var CodeBlock = /*#__PURE__*/memo(function CodeBlock(_ref) {
   var _ref$showLineNumbers = _ref.showLineNumbers,
     showLineNumbers = _ref$showLineNumbers === void 0 ? true : _ref$showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber,
     _ref$language = _ref.language,
     providedLanguage = _ref$language === void 0 ? 'text' : _ref$language,
     _ref$highlight = _ref.highlight,
@@ -40,7 +42,7 @@ var CodeBlock = /*#__PURE__*/memo(function CodeBlock(_ref) {
     codeBidiWarningTooltipEnabled = _ref$codeBidiWarningT === void 0 ? true : _ref$codeBidiWarningT,
     _ref$shouldWrapLongLi = _ref.shouldWrapLongLines,
     shouldWrapLongLines = _ref$shouldWrapLongLi === void 0 ? false : _ref$shouldWrapLongLi;
-  var numLines = (text || '').split('\n').length;
+  var numLines = (text || '').split('\n').length + (firstLineNumber > 0 ? firstLineNumber : 1) - 1;
   var theme = useMemo(function () {
     return getCodeBlockTheme(numLines);
   }, [numLines]);
@@ -74,6 +76,7 @@ var CodeBlock = /*#__PURE__*/memo(function CodeBlock(_ref) {
     language: languageToUse,
     css: styles,
     showLineNumbers: showLineNumbers,
+    firstLineNumber: firstLineNumber,
     lineProps: getLineProps
     // shouldCreateParentElementForLines is needed to pass down props to each line.
     // This is necessary for both line highlighting and testId's, as each of

package/dist/esm/syntax-highlighter/lib/highlight.js

@@ -1,6 +1,6 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 import _objectWithoutProperties from "@babel/runtime/helpers/objectWithoutProperties";
-var _excluded = ["language", "testId", "text", "codeTagProps", "showLineNumbers", "shouldCreateParentElementForLines", "shouldWrapLongLines", "lineProps", "codeBidiWarnings", "codeBidiWarningLabel", "codeBidiWarningTooltipEnabled", "astGenerator"];
+var _excluded = ["language", "testId", "text", "codeTagProps", "showLineNumbers", "firstLineNumber", "shouldCreateParentElementForLines", "shouldWrapLongLines", "lineProps", "codeBidiWarnings", "codeBidiWarningLabel", "codeBidiWarningTooltipEnabled", "astGenerator"];
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
 import { memo } from 'react';
@@ -27,6 +27,8 @@ var Highlight = /*#__PURE__*/memo(function Highlight(_ref) {
     } : _ref$codeTagProps,
     _ref$showLineNumbers = _ref.showLineNumbers,
     showLineNumbers = _ref$showLineNumbers === void 0 ? false : _ref$showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber,
     _ref$shouldCreatePare = _ref.shouldCreateParentElementForLines,
     shouldCreateParentElementForLines = _ref$shouldCreatePare === void 0 ? false : _ref$shouldCreatePare,
     _ref$shouldWrapLongLi = _ref.shouldWrapLongLines,
@@ -70,7 +72,8 @@ var Highlight = /*#__PURE__*/memo(function Highlight(_ref) {
     language: language,
     shouldCreateParentElementForLines: shouldCreateParentElementForLines || !!shouldWrapLongLines,
     lineProps: lineProps,
-    showLineNumbers: showLineNumbers
+    showLineNumbers: showLineNumbers,
+    firstLineNumber: firstLineNumber
   });
 
   // Rows + logic into a renderer

package/dist/esm/syntax-highlighter/lib/process/index.js

@@ -18,9 +18,11 @@ export default function processLines(_ref) {
     language = _ref.language,
     shouldCreateParentElementForLines = _ref.shouldCreateParentElementForLines,
     lineProps = _ref.lineProps,
-    showLineNumbers = _ref.showLineNumbers;
+    showLineNumbers = _ref.showLineNumbers,
+    _ref$firstLineNumber = _ref.firstLineNumber,
+    firstLineNumber = _ref$firstLineNumber === void 0 ? 1 : _ref$firstLineNumber;
   var codeTree = getCodeTree(language, code, astGenerator);
-  var startingLineNumber = 1;
+  var startingLineNumber = firstLineNumber > 0 ? firstLineNumber : 1;
   var createLine = createLineGenerator(lineProps, shouldCreateParentElementForLines, showLineNumbers);
   var newTree = [];
   var lastLineBreakIndex = -1;

package/dist/types/internal/types.d.ts

@@ -14,6 +14,11 @@ export interface CodeBlockProps {
      *  @default true
      */
     showLineNumbers?: boolean;
+    /**
+     * Sets the number of the first line, if showLineNumbers is set to true.
+     * @default 1
+     */
+    firstLineNumber?: number;
     /**
      * Language reference designed to be populated from `SUPPORTED_LANGUAGES` in
      * `design-system/code`. Run against language grammars from PrismJS (full list

package/dist/types/syntax-highlighter/lib/process/index.d.ts

@@ -6,6 +6,7 @@ interface ProcessLines {
     shouldCreateParentElementForLines: boolean;
     lineProps: SyntaxHighlighterLineProps;
     showLineNumbers: boolean;
+    firstLineNumber?: number;
 }
 /**
  * __Line Processor__
@@ -13,5 +14,5 @@ interface ProcessLines {
  * A line processor, that uses refractor to turn code into a tree structure
  * with highlighting metadata and collapses this tree into lines for a renderer.
  */
-export default function processLines({ astGenerator, code, language, shouldCreateParentElementForLines, lineProps, showLineNumbers, }: ProcessLines): RefractorNode[];
+export default function processLines({ astGenerator, code, language, shouldCreateParentElementForLines, lineProps, showLineNumbers, firstLineNumber, }: ProcessLines): RefractorNode[];
 export {};

package/dist/types/syntax-highlighter/types.d.ts

@@ -45,6 +45,11 @@ export interface SyntaxHighlighterProps {
      * Sets whether to display code line numbers or not. Defaults to `true`
      */
     showLineNumbers?: boolean;
+    /**
+     * Sets the number of the first line, if showLineNumbers is set to true.
+     * @default 1
+     */
+    firstLineNumber?: number;
     /**
      * Determines whether or not each line of code should be wrapped in a parent
      * element.

package/dist/types-ts4.5/internal/types.d.ts

@@ -14,6 +14,11 @@ export interface CodeBlockProps {
      *  @default true
      */
     showLineNumbers?: boolean;
+    /**
+     * Sets the number of the first line, if showLineNumbers is set to true.
+     * @default 1
+     */
+    firstLineNumber?: number;
     /**
      * Language reference designed to be populated from `SUPPORTED_LANGUAGES` in
      * `design-system/code`. Run against language grammars from PrismJS (full list

package/dist/types-ts4.5/syntax-highlighter/lib/process/index.d.ts

@@ -6,6 +6,7 @@ interface ProcessLines {
     shouldCreateParentElementForLines: boolean;
     lineProps: SyntaxHighlighterLineProps;
     showLineNumbers: boolean;
+    firstLineNumber?: number;
 }
 /**
  * __Line Processor__
@@ -13,5 +14,5 @@ interface ProcessLines {
  * A line processor, that uses refractor to turn code into a tree structure
  * with highlighting metadata and collapses this tree into lines for a renderer.
  */
-export default function processLines({ astGenerator, code, language, shouldCreateParentElementForLines, lineProps, showLineNumbers, }: ProcessLines): RefractorNode[];
+export default function processLines({ astGenerator, code, language, shouldCreateParentElementForLines, lineProps, showLineNumbers, firstLineNumber, }: ProcessLines): RefractorNode[];
 export {};

package/dist/types-ts4.5/syntax-highlighter/types.d.ts

@@ -45,6 +45,11 @@ export interface SyntaxHighlighterProps {
      * Sets whether to display code line numbers or not. Defaults to `true`
      */
     showLineNumbers?: boolean;
+    /**
+     * Sets the number of the first line, if showLineNumbers is set to true.
+     * @default 1
+     */
+    firstLineNumber?: number;
     /**
      * Determines whether or not each line of code should be wrapped in a parent
      * element.

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/code",
-	"version": "15.3.1",
+	"version": "15.4.0",
 	"description": "Code highlights short strings of code snippets inline with body text.",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"