class Analyzer::Javascript::Apollo

Overview

Apollo Server analyzer.

Extracts endpoints from two surfaces:

  1. Inline typeDefs declarations carried in a backtick template literal (typeDefs = gql\...`ortypeDefs = `#graphql ...``), parsed via the shared GraphQL SDL parser.
  2. The mount path — either an Express app.use('/path', expressMiddleware(...)) position or the standalone default of /graphql.

Schema-first setups that load typeDefs from a separate .graphql file (import typeDefs from './schema.graphql') are handled by the graphql_sdl analyzer, so no work is duplicated here.

Defined in:

analyzer/analyzers/javascript/apollo.cr

Constant Summary

APOLLO_HINTS = ["@apollo/server", "apollo-server", "ApolloServer"]

File-level signals that mark a JS/TS file as Apollo-relevant. The parallel_file_scan walks every JS/TS source, so we gate with a cheap substring check before doing the heavier SDL extraction.

DEFAULT_GRAPHQL_PATH = "/graphql"

Instance Method Summary

Instance methods inherited from class Analyzer

analyze analyze, base_path : String base_path, base_paths : Array(String) base_paths, callees_needed? : Bool callees_needed?, logger : NoirLogger logger, parallel_analyze(channel : Channel(String), &block : String -> Nil) parallel_analyze, read_file_content(path : String) : String read_file_content, result : Array(Endpoint) result, url : String url

Constructor methods inherited from class Analyzer

new(options : Hash(String, YAML::Any)) new

Macros inherited from class Analyzer

define_getter_methods(names) define_getter_methods

Instance methods inherited from module FileHelper

all_files : Array(String) all_files, get_files_by_extension(extension : String) : Array(String) get_files_by_extension, get_files_by_prefix(prefix : String) : Array(String) get_files_by_prefix, get_files_by_prefix_and_extension(prefix : String, extension : String) : Array(String) get_files_by_prefix_and_extension, get_public_dir_files(base_path : String, folder : String) : Array(String) get_public_dir_files, get_public_files(base_path : String, anchors : Array(String) = ["shard.yml", "Gemfile"]) : Array(String) get_public_files, populate_channel_with_files(channel : Channel(String)) populate_channel_with_files, populate_channel_with_filtered_files(channel : Channel(String), extension : String)
populate_channel_with_filtered_files(channel : Channel(String), extensions : Array(String)) populate_channel_with_filtered_files

Instance Method Detail

def analyze #

[View source]