storipress/karbon

Avoid too many `return` statements within this function.
Open

      return {
        ...item,
        [CUSTOM_FIELD_KEY]: customField,
        [CUSTOM_FIELD_EDITOR_BLOCK_KEY]: contentBlock,
      }

Found in packages/karbon/src/runtime/routes/payload-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

      return {
        ...result,
        _key: meta.key,
      }

Found in packages/karbon/src/runtime/routes/api/decrypt-key.ts - About 30 mins to fix

Similar blocks of code found in 2 locations. Consider refactoring.
Open

export interface MetaMap {
  article: ArticleMeta
  desk: DeskMeta
  author: AuthorMeta
  tag: TagMeta

Found in packages/karbon/src/runtime/types.ts and 1 other location - About 30 mins to fix

Read up
Read up

packages/karbon/src/runtime/composables/page-meta.ts on lines 34..39

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 45.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Avoid too many `return` statements within this function.
Open

        return NOT_FOUND

Found in packages/karbon/src/runtime/routes/payload-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

      return NOT_FOUND

Found in packages/karbon/src/runtime/routes/payload-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

      if (isKarbonErrorMeta(items)) return items

Found in packages/karbon/src/runtime/routes/payload-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

    return {
      pass: false,
      message: 'Internal error',
    }

Found in packages/karbon/src/runtime/routes/api/decrypt-key.ts - About 30 mins to fix

Similar blocks of code found in 2 locations. Consider refactoring.
Open

export interface PageTypeMap {
  article: Article
  desk: Desk
  tag: Tag
  author: Author

Found in packages/karbon/src/runtime/composables/page-meta.ts and 1 other location - About 30 mins to fix

Read up
Read up

packages/karbon/src/runtime/types.ts on lines 108..113

Duplicated Code

Duplicated code can lead to software that is hard to understand and difficult to change. The Don't Repeat Yourself (DRY) principle states:

Every piece of knowledge must have a single, unambiguous, authoritative representation within a system.

When you violate DRY, bugs and maintenance problems are sure to follow. Duplicated code has a tendency to both continue to replicate and also to diverge (leaving bugs as two similar implementations differ in subtle ways).

Tuning

This issue has a mass of 45.

We set useful threshold defaults for the languages we support but you may want to adjust these settings based on your project guidelines.

The threshold configuration represents the minimum mass a code block must have to be analyzed for duplication. The lower the threshold, the more fine-grained the comparison.

If the engine is too easily reporting duplication, try raising the threshold. If you suspect that the engine isn't catching enough duplication, try lowering the threshold. The best setting tends to differ from language to language.

See codeclimate-duplication's documentation for more information about tuning the mass threshold in your .codeclimate.yml.

Refactorings

Further Reading

Don't Repeat Yourself on the C2 Wiki
Duplicated Code on SourceMaking
Refactoring: Improving the Design of Existing Code by Martin Fowler. Duplicated Code, p76

Avoid too many `return` statements within this function.
Open

      return renderAsJavascript(result)

Found in packages/karbon/src/runtime/routes/snapshot-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

    return result

Found in packages/karbon/src/runtime/routes/api/decrypt-key.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

      return items.reduce((target, { id, slug: _slug, sid }) => {
        const slug = decodeURIComponent(_slug ?? '')
        slug && Object.assign(target.slugs, { [slug]: id })
        sid && Object.assign(target.sids, { [sid]: id })
        return target

Found in packages/karbon/src/runtime/routes/payload-handler.ts - About 30 mins to fix

Avoid too many `return` statements within this function.
Open

  return null as never

Found in packages/karbon/src/runtime/composables/custom-field.ts - About 30 mins to fix

Function `getResourcesOption` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

export function getResourcesOption<Meta extends ArticleMeta | DeskMeta | AuthorMeta | TagMeta>(
  { type, prefix, resource, isValid, identity = 'id', groupKey }: GetResourcesOptionParams<Meta> = {
    resource: 'article',
  },
): ResourcePage<Meta> {

Found in packages/karbon/src/url/resources-option.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `decryptPaidContent` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

export async function decryptPaidContent(
  contentKey: string,
  rawIv: string,
  segments: Segment[],
  getDecryptKey: (key: string) => Promise<ViewableApiResult>,

Found in packages/karbon/src/runtime/article/utils/inject-paid-content.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `getDefineArticle` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

function getDefineArticle(pageMeta: PageMeta, site: Site) {
  const siteConfig = useSiteConfig()
  const siteUrl = withoutTrailingSlash(siteConfig.url)
  const article: Article = pageMeta.meta
  const authors = article.authors.map((author) => {

Found in packages/karbon/src/runtime/composables/article-schema.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `jsonSafe` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

function jsonSafe() {
  const data = fs.readFileSync(karbonMsg.jsonPosition, { encoding: 'utf-8' })
  const result = JSON.parse(data) as TJson
  const layoutExist = result.layouts.every((item) => fs.existsSync(`.storipress/${item.file}`))
  const blockExist = result.blocks.every(

Found in packages/karbon/src/cli/checkFile/index.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `getAnonymousId` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

async function getAnonymousId(): Promise<string> {
  if (cachedAnonymousId) {
    return cachedAnonymousId
  }

Found in packages/karbon/src/track.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading

Function `getFillArticlesWithSkip` has a Cognitive Complexity of 6 (exceeds 5 allowed). Consider refactoring.
Open

function getFillArticlesWithSkip(
  {
    conditions,
    count,
    identity,

Found in packages/karbon/src/runtime/composables/front-page.ts - About 25 mins to fix

Read up
Read up

Cognitive Complexity

Cognitive Complexity is a measure of how difficult a unit of code is to intuitively understand. Unlike Cyclomatic Complexity, which determines how difficult your code will be to test, Cognitive Complexity tells you how difficult your code will be to read and comprehend.

A method's cognitive complexity is based on a few simple rules:

Code is not considered more complex when it uses shorthand that the language provides for collapsing multiple statements into one
Code is considered more complex for each "break in the linear flow of the code"
Code is considered more complex when "flow breaking structures are nested"

Further reading